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/core docs: fix wrong link in PartialEq #80864

Merged
merged 1 commit into from
Jan 12, 2021
Merged

Conversation

ericseppanen
Copy link
Contributor

PartialEq doc was attempting to link to [`Eq`] but instead we got a link to `eq`. Disambiguate with trait@Eq.

You can see the bad link here (Second sentence, "floating point types implement PartialEq but not Eq").

PartialEq doc was attempting to link to [`Eq`] but instead we got a link
to `eq`. Disambiguate with "trait@Eq".
@rust-highfive
Copy link
Collaborator

r? @m-ou-se

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 10, 2021
@ericseppanen
Copy link
Contributor Author

ericseppanen commented Jan 10, 2021

Looks like this is fairly recent breakage; the bad link only arrived in 1.49, commit 8258cf2.

FYI, @camelid.

@jyn514
Copy link
Member

jyn514 commented Jan 10, 2021

@ericseppanen can you open an issue? This is a bug in rustdoc for several reasons:

  • It shouldn't treat identifiers as case-insensitive
  • It should give a warning if the link is ambiguous

@m-ou-se m-ou-se assigned jyn514 and unassigned m-ou-se Jan 10, 2021
@jyn514 jyn514 added the A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name label Jan 10, 2021
@ericseppanen
Copy link
Contributor Author

It doesn't appear as though the underlying rustdoc behavior is likely to change soon, so I think this is ready to go in, unless someone still feels that [`Eq`][trait@Eq] is preferable over [`trait@Eq`].

@jyn514
Copy link
Member

jyn514 commented Jan 11, 2021

Yep, this looks good to me. Thanks for noticing!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 11, 2021

📌 Commit eef9587 has been approved by jyn514

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 11, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 12, 2021
Rollup of 9 pull requests

Successful merges:

 - rust-lang#79997 (Emit a reactor for cdylib target on wasi)
 - rust-lang#79998 (Use correct ABI for wasm32 by default)
 - rust-lang#80042 (Split a func into cold/hot parts, reducing binary size)
 - rust-lang#80324 (Explain method-call move errors in loops)
 - rust-lang#80864 (std/core docs: fix wrong link in PartialEq)
 - rust-lang#80870 (resolve: Simplify built-in macro table)
 - rust-lang#80885 (rustdoc: Resolve `&str` as `str`)
 - rust-lang#80904 (Fix small typo)
 - rust-lang#80923 (Merge different function exits)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 4646eac into rust-lang:master Jan 12, 2021
@rustbot rustbot added this to the 1.51.0 milestone Jan 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants