Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rustdoc: "Show type declaration" is misleading on traits #50347

Closed
Centril opened this issue Apr 30, 2018 · 1 comment
Closed

Rustdoc: "Show type declaration" is misleading on traits #50347

Centril opened this issue Apr 30, 2018 · 1 comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Centril
Copy link
Contributor

Centril commented Apr 30, 2018

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, From is a trait and not a type, so the documentation is potentially misleading or confusing.

I propose two alternatives to address this problem:

  1. Remove "type" and only say "Show declaration"; This removes information when you actually land on the documentation of a type.

  2. Say "Show trait declaration" instead when it is a trait.
@Centril Centril added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Apr 30, 2018
@GuillaumeGomez
Copy link
Member

I'll go for the first one!

@GuillaumeGomez GuillaumeGomez mentioned this issue Apr 30, 2018
Merged
kennytm added a commit to kennytm/rust that referenced this issue May 3, 2018
@kennytm
Rollup merge of rust-lang#50349 - GuillaumeGomez:rename-type-declarat…
73042c5 
…ion-label, r=estebank

Rename "show type declaration" to "show declaration"

Fixes rust-lang#50347.

r? @QuietMisdreavus
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Centril @GuillaumeGomez