Skip to content

Tracking issue for release notes of #120736: rustdoc: add header map to the table of contents #129964

Closed
@rustbot

Description

This issue tracks the release notes text for #120736.

  • Proposed text is drafted by PR author (or team) making the noteworthy change.
  • Issue is nominated for release team review of clarity for wider audience.
  • Release team includes text in release notes/blog posts.

Release notes text:

The responsible team for the underlying change should edit this section to replace the
automatically generated link with a succinct description of what changed, drawing upon text
proposed by the author (either in discussion or through direct editing). If the change is notable
enough for inclusion in the blog post, add content to the blog section below.

# Rustdoc
- [The sidebar / hamburger menu table of contents now includes the
  `# headers` from the main item's doc comment](https://github.com/rust-lang/rust/pull/120736).
  This is similar to a third-party feature provided by the
  rustdoc-search-enhancements browser extension.

Note: The section title will be de-duplicated by the release team with other release notes issues.
Please use a standard title from previous releases.
More than one section can be included if needed.

Release blog section (if any, leave blank if no section is expected):

cc @notriddle, @GuillaumeGomez -- origin issue/PR authors and assignees for starting to draft text

Metadata

Assignees

No one assigned

    Labels

    relnotesMarks issues that should be documented in the release notes of the next release.relnotes-tracking-issueMarks issues tracking what text to put in release notes.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions