Skip to content

rustdoc: First line of documentation on collapsed impl blocks should be visible #130612

Closed
@crumblingstatue

Description

@crumblingstatue

There exists a technique to make a type's methods more organized, by putting them in separate impl blocks.
This also helps with the organization of the documentation. Makes the various methods much easier to overview and discover.
For an example, take a look at what egui is doing with its Ui type: https://docs.rs/egui/latest/egui/struct.Ui.html
Image

However, if we collapse all the impl blocks, the documentation becomes much harder to overview.

Image

Rustdoc could help the user out here by displaying the first line of the documentation for each collapsed impl block.

Concept art cobbled together in GIMP:
Image

Moreover, there should be an easy way to collapse all impl blocks for easy overview.
Currently, all impl blocks have to be collapsed manually one-by-one. The "collapse all docs" button ignores impl blocks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-rustdoc-uiArea: Rustdoc UI (generated HTML)T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions