From cfc285d0703f5455a06467b1f30ddda5c63e57ba Mon Sep 17 00:00:00 2001
From: Ed Swartz <ed.swartz.258@gmail.com>
Date: Thu, 31 Aug 2023 09:22:03 -0500
Subject: [PATCH] Expose tests for {f32,f64}.total_cmp in docs, along with
 comment

Uncomment the assert! line and account for the sign of NaN not
being positive, necessarily.
---
 library/core/src/num/f32.rs | 13 ++++++++++---
 library/core/src/num/f64.rs | 16 +++++++++++++---
 2 files changed, 23 insertions(+), 6 deletions(-)

diff --git a/library/core/src/num/f32.rs b/library/core/src/num/f32.rs
index f60626b00dc8a..08f02694fe2da 100644
--- a/library/core/src/num/f32.rs
+++ b/library/core/src/num/f32.rs
@@ -1424,9 +1424,16 @@ impl f32 {
     /// ];
     ///
     /// bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));
-    /// # assert!(bois.into_iter().map(|b| b.weight)
-    /// #     .zip([-5.0, 0.1, 10.0, 99.0, f32::INFINITY, f32::NAN].iter())
-    /// #     .all(|(a, b)| a.to_bits() == b.to_bits()))
+    ///
+    /// if f32::NAN.is_sign_negative() {
+    ///     assert!(bois.into_iter().map(|b| b.weight)
+    ///         .zip([f32::NAN, -5.0, 0.1, 10.0, 99.0, f32::INFINITY].iter())
+    ///         .all(|(a, b)| a.to_bits() == b.to_bits()))
+    /// } else {
+    ///     assert!(bois.into_iter().map(|b| b.weight)
+    ///         .zip([-5.0, 0.1, 10.0, 99.0, f32::INFINITY, f32::NAN].iter())
+    ///         .all(|(a, b)| a.to_bits() == b.to_bits()))
+    /// }
     /// ```
     #[stable(feature = "total_cmp", since = "1.62.0")]
     #[must_use]
diff --git a/library/core/src/num/f64.rs b/library/core/src/num/f64.rs
index 0a87021d8c183..640780ffad4c2 100644
--- a/library/core/src/num/f64.rs
+++ b/library/core/src/num/f64.rs
@@ -1422,9 +1422,19 @@ impl f64 {
     /// ];
     ///
     /// bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));
-    /// # assert!(bois.into_iter().map(|b| b.weight)
-    /// #     .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
-    /// #     .all(|(a, b)| a.to_bits() == b.to_bits()))
+    /// ```
+    /// Since the NaN constant does not have a well-defined sign,
+    /// this test may result in either:
+    /// ```
+    /// assert!(bois.into_iter().map(|b| b.weight)
+    ///     .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
+    ///     .all(|(a, b)| a.to_bits() == b.to_bits()))
+    /// ```
+    /// or:
+    /// ```
+    /// assert!(bois.into_iter().map(|b| b.weight)
+    ///     .zip([f64::NAN, -5.0, 0.1, 10.0, 99.0, f64::INFINITY].iter())
+    ///     .all(|(a, b)| a.to_bits() == b.to_bits()))
     /// ```
     #[stable(feature = "total_cmp", since = "1.62.0")]
     #[must_use]