Skip to content

Docs: implementors list could be more readable #41879

Closed
@ghost

Description

Stable Rust: https://doc.rust-lang.org/std/ops/trait.Deref.html#tymethod.deref
Nightly Rust: https://doc.rust-lang.org/nightly/std/ops/trait.Deref.html#tymethod.deref

The docs on stable look better than on nightly.

The problem with nightly is that all these impls written one after another look rather messy.
A few ideas that might help:

  1. Add some spacing between consecutive impls.
  2. Place each impl entirely into a single line (don't place each where clause into a separate line).
  3. Place where and all following clauses into a dedicate line. This is what the stable docs do.

As a side node, the indentation of two spaces in the stable docs looks odd: 4 spaces would look better.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-enhancementCategory: An issue proposing an enhancement or a PR with one.T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.T-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