Skip to content

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

Description

@Centril

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.

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Apr 30, 2018
  2. GuillaumeGomez commented on Apr 30, 2018

    @GuillaumeGomez
    Member

    I'll go for the first one!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: 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.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions