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.

Sign up for GitHub

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

Jump to bottom

Broken link in PartialEq documentation #73233

Closed
Darksonn opened this issue Jun 11, 2020 · 1 comment · Fixed by #73292
Closed

Broken link in PartialEq documentation #73233

Darksonn opened this issue Jun 11, 2020 · 1 comment · Fixed by #73292
Assignees
@rustbot
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@Darksonn
Copy link
Contributor

Darksonn commented Jun 11, 2020 •
edited by rustbot
Loading

In the documentation for PartialEq, you will find the following:

This trait allows for partial equality, for types that do not have a full equivalence relation. For example, in floating point numbers NaN != NaN, so floating point types implement PartialEq but not Eq.

The link on this page is not actually a link to the Eq trait, but a link to the PartialEq::eq method on the same page.

The link is written as [`Eq`] with an [`eq`]: PartialEq::eq in the same doc-comment, so I am unsure whether this should be considered an issue in the documentation, or in rustdoc.

This issue has been assigned to @poliorcetics via this comment.
@lcnr lcnr added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jun 11, 2020
@poliorcetics
Copy link
Contributor

@rustbot claim

@rustbot rustbot self-assigned this Jun 12, 2020
@poliorcetics poliorcetics mentioned this issue Jun 12, 2020
Merged
Manishearth added a commit to Manishearth/rust that referenced this issue Jul 9, 2020
@Manishearth
Rollup merge of rust-lang#73292 - poliorcetics:fix-link-in-partialeq,…
39d4e8e 
… r=Dylan-DPC

Fixing broken link for the Eq trait

Fixes rust-lang#73233.
Manishearth added a commit to Manishearth/rust that referenced this issue Jul 9, 2020
@Manishearth
Rollup merge of rust-lang#73292 - poliorcetics:fix-link-in-partialeq,…
806cfce 
… r=Dylan-DPC

Fixing broken link for the Eq trait

Fixes rust-lang#73233.
@bors bors closed this as completed in 5fc46fa Jul 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rustbot rustbot

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixing broken link for the Eq trait poliorcetics/rust
4 participants
@Darksonn @poliorcetics @lcnr @rustbot