Skip to content
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

Emit more valid HTML from rustdoc #93576

Merged
merged 1 commit into from
Feb 5, 2022
Merged

Commits on Feb 2, 2022

  1. Emit valid HTML from rustdoc

    Previously, tidy-html5 (`tidy`) would complain about a few things in our
    HTML. The main thing is that `<summary>` tags can't contain `<div>`s.
    That's easily fixed by changing out the `<div>`s for `<span>`s with
    `display: block`.
    
    However, there's also a rule that `<span>`s can't contain heading
    elements. `<span>` permits only "phrasing content"
    https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span, and
    `<h3>` (and friends) are "Flow content, heading content, palpable
    content".
    https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements
    
    We have a wrapping `<div>` that goes around each `<h3>`/`<h4>`,
    etc. We turn that into a `<section>` rather than a `<span>` because
    `<section>` permits "flow content".
    https://developer.mozilla.org/en-US/docs/Web/HTML/Element/section
    
    After this change we get only three warnings from tidy, run on
    struct.String.html:
    
    line 6 column 10790 - Warning: trimming empty <span>
    line 1 column 1118 - Warning: <link> proprietary attribute "disabled"
    line 1 column 1193 - Warning: <link> proprietary attribute "disabled"
    
    The empty `<span>` is a known issue - there's a span in front of the
    search box to work around a strange Safari issue.
    
    The `<link>` attributes are the non-default stylesheets. We can probably
    refactor theme application to avoid using this proprietary "disabled"
    attribute.
    jsha committed Feb 2, 2022
    Configuration menu
    Copy the full SHA
    32f6260 View commit details
    Browse the repository at this point in the history