Skip to content

rustdoc: notable traits triggers on all &[T] and &mut [T] returns #100322

Description

@jsha

All methods and functions that return &[T] get the ⓘ Notable Traits icon indicating the return type has some trait that the reader should know about immediately. For instance:

https://doc.rust-lang.org/nightly/std/vec/struct.Vec.html#method.as_slice

image

This shouldn't happen for two reasons:

  • for generic T there's no reason to believe T will be u8, and implying to the user that it will be u8 is just confusing.
  • even when T is u8, the Read and Write impls are far from the most notable thing about &[u8] and &mut [u8]. Rather than attaching a ⓘ to every instance of -> &[u8] and -> &mut [u8] in the documentation, we should rely on the slice page to communicate those impls.

Related: #100320, #55082

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    A-rustdoc-uiArea: Rustdoc UI (generated HTML)
    on Aug 10, 2022
  2. added a commit that references this issue on Mar 22, 2023
    0392e29
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-rustdoc-uiArea: Rustdoc UI (generated HTML)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