-
-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Add an overview toggle to rustdoc lib output #28057
Copy link
Copy link
Open
Labels
C-feature-requestCategory: A feature request, i.e: not implemented / a PR.Category: A feature request, i.e: not implemented / a PR.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Metadata
Metadata
Assignees
Labels
C-feature-requestCategory: A feature request, i.e: not implemented / a PR.Category: A feature request, i.e: not implemented / a PR.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Rustdoc libs should have an overview button of some sort.
As discussed here, one problem with the std docs is that you can't tell which part of an unfamiliar page is actually useful. For example, below is a mockup of what the main regex page would look like with and without the types which can only be created indirectly. Clearly the top part is much more approachable to someone unfamiliar with this library.
This seems a somewhat reasonable thing to do although I'm not certain
expand/overvieware the best words or icons for this but it seems okay I guess. One alternative would be to only show indirectly created types where they're being returned (but that is more drastic and it seems it could be done after this was tried if this was really well liked).cc @BurntSushi since this interested you