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

std::cmp Documentation has some typos #60614

Closed
OptimisticPeach opened this issue May 7, 2019 · 2 comments
Closed

std::cmp Documentation has some typos #60614

OptimisticPeach opened this issue May 7, 2019 · 2 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug.

Comments

@OptimisticPeach
Copy link
Contributor

Hi there, I was just browsing the std::cmp documentation and came across some funny looking text:

  • [Eq] and [PartialEq] are traits that allow you to define total and partial equality between values, respectively. Implementing them overloads the == and != operators.
  • [Ord] and [PartialOrd] are traits that allow you to define total and partial orderings between values, respectively. Implementing them overloads the <, <=, >, and >= operators.
  • [Ordering][cmp::Ordering] is an enum returned by the main functions of [Ord] and [PartialOrd], and describes an ordering.
  • [Reverse][cmp::Reverse] is a struct that allows you to easily reverse an ordering.
  • [max][cmp::max] and [min][cmp::min] are functions that build off of [Ord] and allow you to find the maximum or minimum of two values.

It seems that there are just a few links that are broken, so I thought I'd just make an issue. I would submit a PR with the fix, but I'm not sure how to do these kinds links.

@Centril Centril added C-bug Category: This is a bug. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels May 7, 2019
@ehuss
Copy link
Contributor

ehuss commented May 7, 2019

This is #59833. intra-rustdoc-links has issues with reexporting between crates.

@OptimisticPeach
Copy link
Contributor Author

Closing in favor of #59833

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug.
Projects
None yet
Development

No branches or pull requests

3 participants