docs: clarify that partial comparator expansions are not substitution-safe - #353
Open
TrueFurina wants to merge 1 commit into
Open
TrueFurina wants to merge 1 commit into
TrueFurina wants to merge 1 commit into
Conversation
Author
|
Friendly ping - this is still open on my side and mergeable as far as I can tell. Happy to address any remaining feedback if something is blocking it. Thanks! |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #350 (option 2: keep the matcher behavior intentional, make the docs not
overclaim).
Problem
The
Opdocs describe partial comparators with "equivalent to", e.g.>I.Jequivalent to
>=I.(J+1).0. At the publicVersionReq::matchesAPI theseexpansions are not substitution-safe once prerelease admission is involved
across multiple comparators:
Both reproducers from #350 were verified locally against semver 1.x
(assertions hold exactly as reported).
Fix (docs-only)
describing how each form is interpreted on its own rather than claiming a
rewrite rule.
Opstates explicitly that the expansions are notfreely substitutable inside a multi-comparator
VersionReqwhen prereleaseadmission is involved, and to prefer the form matching your intent.
Verification
(pre-change docs claim falsified, matcher behavior confirmed intentional)
cargo teston this branch: 4 passed / 0 failed