-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.Category: This is a bug.T-libsRelevant to the library team, which will review and decide on the PR/issue.Relevant to the library team, which will review and decide on the PR/issue.

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
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.Category: This is a bug.T-libsRelevant to the library team, which will review and decide on the PR/issue.Relevant to the library team, which will review and decide on the PR/issue.