Skip to content
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

"Specifying dependencies" reference lists = exact version operator under "inequalities" #6958

Closed
huonw opened this issue May 19, 2019 · 0 comments · Fixed by #6963
Closed
Labels
C-bug Category: bug

Comments

@huonw
Copy link
Member

huonw commented May 19, 2019

Problem

The = exact-version semver operator is listed under the section "Inequality requirements": https://github.com/rust-lang/cargo/blob/0.35.0/src/doc/src/reference/specifying-dependencies.md#inequality-requirements. I imagine many people would consider = to be an equality requirement, not inequality. Someone skimming to find the definition of the = operator may skip over that section.

Steps

  1. go to the "Specifying Dependencies" section of the reference
  2. try to find the definition of =

Possible Solution(s)

Rename the section to something like "Equality and inequality requirements" or "Comparison requirements".

Notes

Output of cargo version: the link above is to the reference for v0.35.0.

@huonw huonw added the C-bug Category: bug label May 19, 2019
bors added a commit that referenced this issue May 20, 2019
Change docs "inequality" for semver requirement.

I can see how "inequality" may be confusing. I considered a few other words ("operator", "range", "relational"), but settled on "comparison" since it conveys that it is *comparing* against a value. npm uses the term "comparator".

Closes #6958
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant