Using X headings #39850

[projektir]

Fix for issue #39850, the headings should now be 1, 2, and 3.

[rust-highfive]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @frewsxcv (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

[frewsxcv]

Thanks! @bors r+ rollup

[bors]

📌 Commit 11d3344 has been approved by frewsxcv

[steveklabnik]

This is a big bummer because now we get multiple H1s on the page.

[frewsxcv]

I don't think there's anything wrong with having multiple <h1>s on a page. The HTML spec even has an example consisting solely of nested <h1> headings:

https://html.spec.whatwg.org/multipage/semantics.html#headings-and-sections

[frewsxcv]

Though, after reading again, that's probably because they're using <section>s to indicate sub-headings. Regardless, I'm still in favor of these changes since I don't see how a series of adjacent <h1>s is semantically any worse than a series of adjacent parent-less <h2>s.

[steveklabnik]

Yeah, I think that the change is fine, just something to fix someday...

…

On Mon, Mar 13, 2017 at 8:16 PM, Corey Farwell ***@***.***> wrote: Though, after reading again, that's probably because they're using <section>s to indicate sub-headings. Regardless, I'm still in favor of these changes since I don't see how a series of adjacent <h1>s is any worse than a series of adjacent parent-less <h2>s. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#40496 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABsin2RHJirJQB_1tiH3--euZOpZIlRks5rldxEgaJpZM4Mb71z> .

[projektir]

@steveklabnik the Grammar page seems to be doing the same thing. But if you think this is a poor change, it seems that at least one h1 heading is needed or the 0.x issue will occur. This seems to be an effect coming from mdBook (?), maybe if this was treated as just a straight up Markdown page this wouldn't happen?

I'm happy to undo this or research further to fix this properly.

[steveklabnik]

This page is rendered by rustdoc, not mdbook. It might be rust.css, I'm not sure.

[projektir]

I've looked at rustdoc, and the numbering seems to be managed by the ToC generator and the 0.x even looks like expected behavior. Perhaps it can be modified to treat the % title as a parent, since that will become an <h1>.

I will note that, from the looks of it, if you have an X in your Markdown at all, you're going to have multiple <h1>'s, since there's always at least one <h1> for the % title. Perhaps X's should become <h2>'s and so on, but I don't know how you guys typically use Markdown.

I'll look at it and see if I can figure something out and undo this change as well as fix the grammar page.

[steveklabnik]

Perhaps it can be modified to treat the % title as a parent, since that will become an

.

I really hate that the % is even a thing. So much work to do with rustdoc, ugh.