Say that the identity holds only for all finite numbers (aka not NaN)

rust-lang-ci · Aug 15, 2022 · 3f10e6c · 3f10e6c
1 parent a1e2510
commit 3f10e6c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/library/core/src/num/f32.rs b/library/core/src/num/f32.rs
@@ -688,7 +688,7 @@ impl f32 {
     ///  - if `self` is [`MAX`] or [`INFINITY`], this returns [`INFINITY`];
     ///  - otherwise the unique least value greater than `self` is returned.
     ///
-    /// The identity `x.next_up() == -(-x).next_down()` holds for all `x`. When `x`
+    /// The identity `x.next_up() == -(-x).next_down()` holds for all non-NaN `x`. When `x`
     /// is finite `x == x.next_up().next_down()` also holds.
     ///
     /// ```rust
@@ -738,7 +738,7 @@ impl f32 {
     ///  - if `self` is [`MIN`] or [`NEG_INFINITY`], this returns [`NEG_INFINITY`];
     ///  - otherwise the unique greatest value less than `self` is returned.
     ///
-    /// The identity `x.next_down() == -(-x).next_up()` holds for all `x`. When `x`
+    /// The identity `x.next_down() == -(-x).next_up()` holds for all non-NaN `x`. When `x`
     /// is finite `x == x.next_down().next_up()` also holds.
     ///
     /// ```rust

diff --git a/library/core/src/num/f64.rs b/library/core/src/num/f64.rs
@@ -698,7 +698,7 @@ impl f64 {
     ///  - if `self` is [`MAX`] or [`INFINITY`], this returns [`INFINITY`];
     ///  - otherwise the unique least value greater than `self` is returned.
     ///
-    /// The identity `x.next_up() == -(-x).next_down()` holds for all `x`. When `x`
+    /// The identity `x.next_up() == -(-x).next_down()` holds for all non-NaN `x`. When `x`
     /// is finite `x == x.next_up().next_down()` also holds.
     ///
     /// ```rust
@@ -748,7 +748,7 @@ impl f64 {
     ///  - if `self` is [`MIN`] or [`NEG_INFINITY`], this returns [`NEG_INFINITY`];
     ///  - otherwise the unique greatest value less than `self` is returned.
     ///
-    /// The identity `x.next_down() == -(-x).next_up()` holds for all `x`. When `x`
+    /// The identity `x.next_down() == -(-x).next_up()` holds for all non-NaN `x`. When `x`
     /// is finite `x == x.next_down().next_up()` also holds.
     ///
     /// ```rust