Skip to content

Documentation of libstd is lacking of comments on trait implementations #31821

Closed
@ticki

Description

@ticki

Currently, a lot of the implementation on types in libstd is unexplained, and the behavior of these are not always obvious.

For example,PartialOrd<char> for char is unexplained. Since the exact behavior can unobvious in this case, it should be properly documented (that it compares the unicode codepoints, based on their value). This is just one of the many undocumented implementations in libstd.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.P-mediumMedium priorityT-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