-
-
Notifications
You must be signed in to change notification settings - Fork 14.7k
Rustdoc: "Show type declaration" is misleading on traits #50347
Copy link
Copy link
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-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
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-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.
If we visit a page such as: https://doc.rust-lang.org/nightly/std/convert/trait.From.html
we will see "Show type declaration" when folding of the declaration is done.
However,
Fromis a trait and not a type, so the documentation is potentially misleading or confusing.I propose two alternatives to address this problem:
Remove "type" and only say "Show declaration"; This removes information when you actually land on the documentation of a type.
Say "Show trait declaration" instead when it is a trait.