You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It seems like documentation comments on trait methods get unescaped when they are shown as implemented traits. Something like a\*b\*c\* shows up as a*b*c* in the trait documentation, but as abc* when looking at a type that implements the trait. Adding double escapes makes it look bad on the trait page instead, and replacing * with * doesn't help, since it gets reinterpreted as * anyway.
The text was updated successfully, but these errors were encountered:
…illaumeGomez
rustdoc: do not use plain summary for trait impls
Fixesrust-lang#38386.
Fixesrust-lang#48332.
Fixesrust-lang#49430.
Fixesrust-lang#62741.
Fixesrust-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!
It seems like documentation comments on trait methods get unescaped when they are shown as implemented traits. Something like
a\*b\*c\*
shows up as a*b*c* in the trait documentation, but as abc* when looking at a type that implements the trait. Adding double escapes makes it look bad on the trait page instead, and replacing*
with*
doesn't help, since it gets reinterpreted as*
anyway.The text was updated successfully, but these errors were encountered: