Skip to content
Snippets Groups Projects
Unverified Commit 1dc71e9d authored by Julian Tölle's avatar Julian Tölle Committed by GitHub
Browse files

docs: clarify semverCompare return value

The return value for `semverCompare` was not explicitly listed in the docs,
and I had to go check in the source code wether it's actually a boolean.

By listing the return type in the docs, we can make usage easier for other people.
parent 05f1d182
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment