about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2023-02-06 21:16:41 +0100
committerGitHub <noreply@github.com>2023-02-06 21:16:41 +0100
commit7c4e6edb056d00dd02ac7caa8acacb125d79dd28 (patch)
treead0cdd23e95761dc8b835a248a4f4b9d7f6301e9
parenta5288a7803e52d75d9101bb47225b187fd88272f (diff)
parent4a7a9b4e74fce7d39e53aeae3b85cdfc7bb588a6 (diff)
downloadrust-7c4e6edb056d00dd02ac7caa8acacb125d79dd28.tar.gz
rust-7c4e6edb056d00dd02ac7caa8acacb125d79dd28.zip
Rollup merge of #107714 - Wilfred:round_docs, r=m-ou-se
Clarify wording on f64::round() and f32::round()

"Round half-way cases" is a little confusing (it's a 'garden path sentence' as it's not immediately clear whether round is an adjective or verb).

Make this sentence longer and clearer.
-rw-r--r--library/std/src/f32.rs4
-rw-r--r--library/std/src/f64.rs4
2 files changed, 4 insertions, 4 deletions
diff --git a/library/std/src/f32.rs b/library/std/src/f32.rs
index 4e300762463..6b1f0cba82d 100644
--- a/library/std/src/f32.rs
+++ b/library/std/src/f32.rs
@@ -69,8 +69,8 @@ impl f32 {
         unsafe { intrinsics::ceilf32(self) }
     }
 
-    /// Returns the nearest integer to `self`. Round half-way cases away from
-    /// `0.0`.
+    /// Returns the nearest integer to `self`. If a value is half-way between two
+    /// integers, round away from `0.0`.
     ///
     /// # Examples
     ///
diff --git a/library/std/src/f64.rs b/library/std/src/f64.rs
index ec67fdad4f7..16359766b51 100644
--- a/library/std/src/f64.rs
+++ b/library/std/src/f64.rs
@@ -69,8 +69,8 @@ impl f64 {
         unsafe { intrinsics::ceilf64(self) }
     }
 
-    /// Returns the nearest integer to `self`. Round half-way cases away from
-    /// `0.0`.
+    /// Returns the nearest integer to `self`. If a value is half-way between two
+    /// integers, round away from `0.0`.
     ///
     /// # Examples
     ///