-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
links on first line of trait description are gone #38386
Comments
Hmm, from what I could tell by looking at the same method in std in various versions of the std docs, this probably hasn't worked for the trait function summaries since they were printed in the first place. The summary lines in modules can format links just fine, so I'll take a look and see if that code can be adapted to trait impl rendering. |
I could see "just render it so the link exists" backfiring because links are typically specified as relative links. This specific example would likely work because the link to |
…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!
See for example doc for the method scan: https://docs.rs/rawslice/0.1.0/rawslice/struct.SliceIter.html#method.scan
The link at
fold()
is removed because only the first line is shown in the trait impl documentation.The text was updated successfully, but these errors were encountered: