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

rustdoc: "Implementations on Foreign Types" sidebar items should link to specific impls #56018

Open
NPN opened this issue Nov 17, 2018 · 0 comments
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. S-needs-repro Status: This issue has no reproduction and needs a reproduction to make progress. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@NPN
Copy link

NPN commented Nov 17, 2018

Each of the impl sections in the "Implementations on Foreign Types" section has its own ID. Consider the foreign impls for the Stream trait from tokio. The first impl header is #impl-Stream, the second impl header is #impl-Stream-1, the third impl header is #impl-Stream-2, and so on.

But, the links in the sidebar do not jump to these specific IDs. Instead, they all link to #impl-Stream, or the first impl in the list. For a trait like Stream, which has many methods and many foreign implementors, this makes it difficult to get to a specific impl (to see the associated types, for example). You have to search the page, collapse the sections, or just scroll.

Since unique IDs are already generated for the impl sections, it would be great if the sidebar items used them to make navigation easier.

@jonas-schievink jonas-schievink added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 27, 2019
Centril added a commit to Centril/rust that referenced this issue Apr 27, 2019
Make "Implementations on Foreign Types" items in sidebar link to specific impls

This solves rust-lang#56018 for most cases (though not work for foreign impls with same names)
Centril added a commit to Centril/rust that referenced this issue Apr 27, 2019
Make "Implementations on Foreign Types" items in sidebar link to specific impls

This solves rust-lang#56018 for most cases (though not work for foreign impls with same names)
@fmease fmease added C-bug Category: This is a bug. S-needs-repro Status: This issue has no reproduction and needs a reproduction to make progress. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. S-needs-repro Status: This issue has no reproduction and needs a reproduction to make progress. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants