rustdoc: First line of documentation on collapsed impl blocks should be visible #130612
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.
T-rustdoc-frontend
Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
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.htmlHowever, if we collapse all the impl blocks, the documentation becomes much harder to overview.
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:
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.
The text was updated successfully, but these errors were encountered: