Skip to content

Documentation for log functions is mixed up for all integer and unsigned integer types #96545

Closed

Description

See for example for the types u32 and i32 and the function log2.

For u32::log2 we can read:

When the number is negative or zero it panics in debug mode and the return value is 0 in release mode.

For i32::log2:

When the number is zero it panics in debug mode and the return value is 0 in release mode.

The word negative only makes sense for i32 and not for u32 but it's exactly written the opposite. So, it's missing where it's important and it's written where it's not possible. The documentation was probably autogenerated, I think.
I think this PR is related

Activity

  1. added
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    C-bugCategory: This is a bug.
    T-libsRelevant to the library team, which will review and decide on the PR/issue.
    on Apr 29, 2022
  2. alex-semenyuk commented on Apr 29, 2022

    @alex-semenyuk
    Member

    @rustbot claim

  3. added a commit that references this issue on May 2, 2022
    f581354
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.T-libsRelevant to the library 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