Merge pull request #325 from apricote/patch-1

docs: clarify semverCompare return value
Masterminds · May 3, 2022 · ae1d86e · ae1d86e
2 parents 1509093 + 1dc71e9
commit ae1d86e
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/semver.md b/docs/semver.md
@@ -43,8 +43,8 @@ comparison operations.)
 
 ## semverCompare
 
-A more robust comparison function is provided as `semverCompare`. This version
-supports version ranges:
+A more robust comparison function is provided as `semverCompare`. It returns `true` if
+the constraint matches, or `false` if it does not match. This version supports version ranges:
 
 - `semverCompare "1.2.3" "1.2.3"` checks for an exact match
 - `semverCompare "^1.2.0" "1.2.3"` checks that the major and minor versions match, and that the patch