rustdoc: Add more semantic information to impl IDs #98939
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
GuillaumeGomez
added
the
T-rustdoc
|
Hey! It looks like you've submitted a new PR for the library teams! If this PR contains changes to any Examples of
|
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
rustdoc-disamb-impls
branch
from
67a3caf to
be822ff
Compare
|
Fixed formatting error. |
This comment has been minimized.
This comment has been minimized.
Instead of generating `#impl`, `#impl-1`, etc., generate IDs like `#impl-Foo<M>`. Co-authored-by: Noah Lev <camelidcamel@gmail.com>
GuillaumeGomez
force-pushed
the
rustdoc-disamb-impls
branch
from
be822ff to
e409532
Compare
|
And rebased on master. |
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
rustdoc-disamb-impls
branch
from
e409532 to
53db831
Compare
|
And now the GUI tests... |
|
@bors r+ rollup |
|
📌 Commit 53db831 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jul 6, 2022
…laumeGomez Rollup of 7 pull requests Successful merges: - rust-lang#96935 (Allow arithmetic and certain bitwise ops on AtomicPtr) - rust-lang#98519 (Replace some `guess_head_span` with `def_span`) - rust-lang#98911 (rustdoc: filter '_ lifetimes from ty::Generics) - rust-lang#98939 (rustdoc: Add more semantic information to impl IDs) - rust-lang#98971 (Fix typo in file descriptor docs) - rust-lang#98983 (docs: Add overview of `rustc_middle::mir::TerminatorKind`) - rust-lang#98984 (Remove erroneous doc comment) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
|
Thanks so much for this, @GuillaumeGomez! 🙏 |
|
Thanks for starting it. I didn't have much to do in the end so you were quite close. 😉 |
nars1
pushed a commit
to YottaDB/YDBRust
that referenced
this pull request
Sep 29, 2022
**Change** * Pipeline job `pages` started failing because of the error shown below ``` Found invalid urls in struct.Context.html: Fragment #impl-Display at struct.YDBError.html does not exist! ``` * This error is from execution of `cargo deadlinks` command * This error is due to the fact that implementation of trait `fmt::Display` for `YDBError` was not found at fragment `impl-Display` of `struct.YDBError.html` * This error started occuring with the `rust version 1.64.0 (a55dd71d5 2022-09-19)` and not before. The previous version as seen in pipeline jobs previous to this failure is `1.63.0 (4b91a6ea7 2022-08-08)` * When attempted to generate the docs locally it was found that the documentation for `Display` with the new rust version (1.64.0) was seen at fragment `impl-Display-for-YDBError` * Changing the fragment part in rustdoc solved the issue * The following pull request seems to have introduced this change to rustdoc rust-lang/rust#98939 (rustdoc: Add more semantic information to impl IDs #98939) and this is the issue on github related to this change -> rust-lang/rust#92052 (rustdoc: Semantically disambiguate impls and associated impl items rather than using numeric suffixes #92052) **Misc** * @jsikri94 found another issue where the intra-doc link format was broken. This change also fixed the issue. * Previous to this change following line was seen in docs : `ci_t! and cip_t! cip_t!: crate::cip_t! ci_t!: crate::ci_t!` * After this change it is replaced by : `ci_t! and cip_t!` * The fix was to include an empty line between the intra link and its definition. As it was absent both the lines were being combined into one as seen above in the first sub-point. With the empty line the line seen in docs is fixed and is seen as shown by the second sub-point above.
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.
Take over of #92745.
I fixed the last remaining issue for the links in the sidebar (mentioned by @jsha) and fixed the few links broken in the std/core docs.
cc @camelid
r? @notriddle