-
Notifications
You must be signed in to change notification settings - Fork 149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
,-beta
etc.) may not be API compliant with their release counterpart. It says,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.