-
Notifications
You must be signed in to change notification settings - Fork 2.9k
subtle documentation ambiguity #12112
Copy link
Copy link
Closed
Labels
A-documenting-cargo-itselfArea: Cargo's documentationArea: Cargo's documentationA-semverArea: semver specifications, version matching, etc.Area: semver specifications, version matching, etc.C-bugCategory: bugCategory: bugE-easyExperience: EasyExperience: EasyS-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or reviewStatus: Issue or feature is accepted, and has a team member available to help mentor or review
Metadata
Metadata
Assignees
Labels
A-documenting-cargo-itselfArea: Cargo's documentationArea: Cargo's documentationA-semverArea: semver specifications, version matching, etc.Area: semver specifications, version matching, etc.C-bugCategory: bugCategory: bugE-easyExperience: EasyExperience: EasyS-acceptedStatus: Issue or feature is accepted, and has a team member available to help mentor or reviewStatus: Issue or feature is accepted, and has a team member available to help mentor or review
Type
Fields
Give feedbackNo fields configured for issues without a type.
Problem
The Cargo Book says:
This phrasing has an unfortunate interpretation for Rust newbies, who may take the statement to mean that caret means the exact version identifier.
A very careful reading reveals that caret is merely the default semantic, but is not exactly equivalent to any fixed version. Some users may get tripped up by this ambiguity.
Possible Solution(s)
We can help the reader to disambiguate Cargo syntax and semantics. For example, adjust the section to say something like: