doc: Fix external mention of signum() return value regarding NaNs - #162576
Merged
Conversation
rustbot
added
S-waiting-on-review
Collaborator
|
r? @Darksonn rustbot has assigned @Darksonn. Use Why was this reviewer chosen?The reviewer was selected based on:
|
Darksonn
approved these changes
Sep 10, 2026
| pub const fn is_sign_negative(self) -> bool { | ||
| // IEEE754 says: isSignMinus(x) is true if and only if x has negative sign. isSignMinus | ||
| // applies to zeros and NaNs as well. | ||
| // SAFETY: This is just transmuting to get the sign bit, it's fine. |
Member
There was a problem hiding this comment.
unrelated but these SAFETY comments look stale
Contributor
rust-bors
Bot
added
S-waiting-on-bors
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Sep 10, 2026
…=Darksonn doc: Fix external mention of signum() return value regarding NaNs `is_sign_positive()`/`is_sign_negative()` documentation refer to using `signum() ` but misrepresent the return value of the latter; `signum()` returns a float so it cannot be `false`; `signum()` documentation documents it as returning a NaN in this case, so propagated that to these references.
rust-bors Bot
pushed a commit
that referenced
this pull request
Sep 10, 2026
…uwer Rollup of 6 pull requests Successful merges: - #162581 (Subtree sync for rustc_codegen_cranelift) - #160831 (re-equate the object bound's trait ref with the goal's when considering object bounds) - #162057 (Some cleanups around fatal errors and delayed bugs) - #162437 (fix(traits): Remove expression references from index suggestions) - #162534 (Fix run-make/prune-link-args to work with MinGW) - #162576 (doc: Fix external mention of signum() return value regarding NaNs)
rust-bors Bot
pushed a commit
that referenced
this pull request
Sep 10, 2026
…uwer Rollup of 6 pull requests Successful merges: - #162581 (Subtree sync for rustc_codegen_cranelift) - #160831 (re-equate the object bound's trait ref with the goal's when considering object bounds) - #162057 (Some cleanups around fatal errors and delayed bugs) - #162437 (fix(traits): Remove expression references from index suggestions) - #162534 (Fix run-make/prune-link-args to work with MinGW) - #162576 (doc: Fix external mention of signum() return value regarding NaNs)
rust-bors Bot
pushed a commit
that referenced
this pull request
Sep 10, 2026
…uwer Rollup of 7 pull requests Successful merges: - #162581 (Subtree sync for rustc_codegen_cranelift) - #160831 (re-equate the object bound's trait ref with the goal's when considering object bounds) - #162057 (Some cleanups around fatal errors and delayed bugs) - #162437 (fix(traits): Remove expression references from index suggestions) - #162534 (Fix run-make/prune-link-args to work with MinGW) - #162554 (Attemped fix for home dir problem on `dist-aarch64-llvm-mingw`) - #162576 (doc: Fix external mention of signum() return value regarding NaNs)
rust-bors Bot
pushed a commit
that referenced
this pull request
Sep 10, 2026
Rollup merge of #162576 - xkr47:fix/doc-signum-nan-return, r=Darksonn doc: Fix external mention of signum() return value regarding NaNs `is_sign_positive()`/`is_sign_negative()` documentation refer to using `signum() ` but misrepresent the return value of the latter; `signum()` returns a float so it cannot be `false`; `signum()` documentation documents it as returning a NaN in this case, so propagated that to these references.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
is_sign_positive()/is_sign_negative()documentation refer to usingsignum()but misrepresent the return value of the latter;signum()returns a float so it cannot befalse;signum()documentation documents it as returning a NaN in this case, so propagated that to these references.