remove horizontal rule from Markdown-generated HTML #90033
Labels
A-rustdoc-ui
Area: rustdoc UI (generated HTML)
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
jyn514
added
A-async-await
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this issue
Oct 19, 2021
Remove border-bottom from most docblocks. Headings in the top-doc docblock still get a border-bottom due to a rule that covers all h2, h3, and h4. Method docblocks are generally h5, and so don't get a border-bottom anymore. This fixes a problem where a sub-sub-heading within a method would have a line that went all the way across the page, creating a division that made that sub-sub-heading look much more important than it really is. Fixes rust-lang#90033 Demo at https://jacob.hoffman-andrews.com/rust/less-rule/std/string/struct.String.html r? `@GuillaumeGomez`
15 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When documentation has markdown headings (e.g.
# Foo,## Bar, etc), we currently display those with a horizontal rule (<hr>) across the whole page. However, that makes sub-sub-headings, likePanicsin the below screenshot of https://docs.rs/rctree/0.4.0/rctree/struct.Node.html, look more prominent than their parents in the document structure. They also make the page look grouped along lines that it's not intended to be grouped along.We should remove or hide these elements to improve the scannability of pages. Most likely we want to keep them when they are part of the docblock at the very top of the page, but hide them elsewhere.
The text was updated successfully, but these errors were encountered: