Closed
Description
openedon Aug 9, 2022
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
This shouldn't happen for two reasons:
- for generic T there's no reason to believe
T
will beu8
, and implying to the user that it will beu8
is just confusing. - even when T is u8, the
Read
andWrite
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 theslice
page to communicate those impls.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Metadata
Assignees
Labels
Area: Rustdoc UI (generated HTML)Area: Rustdoc UI (generated HTML)Relevant 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.