Skip to content

rustdoc doesn't render links in Trait Implementations sections #62741

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
Closed
tesuji opened this issue Jul 17, 2019 · 4 comments · Fixed by #73819
Closed

rustdoc doesn't render links in Trait Implementations sections #62741

tesuji opened this issue Jul 17, 2019 · 4 comments · Fixed by #73819
Assignees
@GuillaumeGomez
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tesuji
Copy link
Contributor

tesuji commented Jul 17, 2019 •
edited
Loading

https://doc.rust-lang.org/nightly/std/iter/struct.Flatten.html#method.scan
image
https://doc.rust-lang.org/nightly/std/iter/trait.Iterator.html#method.scan
image

As we can see, fold is not linked in the first image.
@tesuji

This comment has been minimized.

Sign in to view
@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 17, 2019
@GuillaumeGomez GuillaumeGomez self-assigned this Jul 19, 2019
@GuillaumeGomez
Copy link
Member

Problem isn't coming from intra links contrary to my first thought but just that we're "removing" links. For instance we use [fold] but define it below, therefore the markdown cannot generate the link.

@tesuji
Copy link
Contributor Author

tesuji commented Aug 10, 2019

I don't get it. But if you see this as won't fix, feels free to close this issue.

@GuillaumeGomez
Copy link
Member

No, I wrote the fix. However it'll certainly break a few things in the std (same issue with short doc when listing items at the top level, the non absolute urls will be bad haha).

@GuillaumeGomez GuillaumeGomez mentioned this issue Aug 10, 2019
Closed
@euclio euclio mentioned this issue Jun 28, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this issue Sep 3, 2020
@bors
Auto merge of rust-lang#73819 - euclio:rustdoc-summaries, r=jyn514,Gu…
62dad45 
…illaumeGomez

rustdoc: do not use plain summary for trait impls

Fixes rust-lang#38386.
Fixes rust-lang#48332.
Fixes rust-lang#49430.
Fixes rust-lang#62741.
Fixes rust-lang#73474.

Unfortunately this is not quite ready to go because the newly-working links trigger a bunch of linkcheck failures. The failures are tough to fix because the links are resolved relative to the implementor, which could be anywhere in the module hierarchy.

(In the current docs, these links end up rendering as uninterpreted markdown syntax, so I don't think these failures are any worse than the status quo. It might be acceptable to just add them to the linkchecker whitelist.)

Ideally this could be fixed with intra-doc links ~~but it isn't working for me: I am currently investigating if it's possible to solve it this way.~~ Opened rust-lang#73829.

EDIT: This is now ready!
@bors bors closed this as completed in e0822ec Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GuillaumeGomez GuillaumeGomez

Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
3 participants
@GuillaumeGomez @tesuji @rustbot