Fix doc link to Eq trait from PartialEq trait #71680
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `Eq` link was incorrectly going to the `eq` method of `PartialEq` instead of to the `Eq` trait.
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
Incidentally it took me a while to figure out how to fix this link. Google turns up a lot of stuff about writing doc comments in rust but the stuff on how to add links is kind of confusing, sometimes refers to RFCs without mentioning whether the RFC was actually accepted. Maybe adding a sentence like "the link target goes at the end of the doc comment" in the various docs on writing docs could be a helpful addition? |
|
We would be happy to consider PRs improving docs, including the docs on how to write docs :) @bors r+ rollup |
|
📌 Commit f408a4e has been approved by |
bors
added
S-waiting-on-bors
|
Good advice, I put up a PR here: rust-lang/api-guidelines#220 |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Apr 29, 2020
Rollup of 6 pull requests Successful merges: - rust-lang#71507 (Document unsafety in core::ptr) - rust-lang#71572 (test iterator chain type length blowup) - rust-lang#71617 (Suggest `into` instead of `try_into` if possible with int types) - rust-lang#71627 (Fix wrong argument in autoderef process) - rust-lang#71678 (Add an index page for nightly rustc docs.) - rust-lang#71680 (Fix doc link to Eq trait from PartialEq trait) Failed merges: - rust-lang#71597 (Rename Unique::empty() -> Unique::dangling()) r? @ghost
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
Eqlink was incorrectly going to theeqmethod ofPartialEqinstead of to the
Eqtrait.