Update the docs on pre-release comparator handling #71
Conversation
There has been confusion on the use of pre-releases in comparison ranges. This attempts to add more detail to help end users figure them out.
There was a problem hiding this comment.
@mattfarina it looks great to me - perhaps you could add a clarification about the meaning of a pre-release?
README.md
Outdated
|
|
||
| > _A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version._ | ||
| According to the Semantic Version specification pre-releases may not be |
There was a problem hiding this comment.
I initially arrived to the semver repo without a clear conception of what a pre-release was, perhaps you could help the former me by adding a small parenthesis clarification.
According to the Semantic Version specification pre-releases (
-alpha,-betaetc.) may not be API compliant with their release counterpart. It says,
There was a problem hiding this comment.
I agree -- a quick mention might help. I'd consider it a non-blocker, though. Otherwise, this looks great.
README.md
Outdated
|
|
||
| > _A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version._ | ||
| According to the Semantic Version specification pre-releases may not be |
There was a problem hiding this comment.
I agree -- a quick mention might help. I'd consider it a non-blocker, though. Otherwise, this looks great.
There has been confusion on the use of pre-releases in comparison
ranges. This attempts to add more detail to help end users
figure them out.