about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2023-11-28 09:28:39 +0100
committerGitHub <noreply@github.com>2023-11-28 09:28:39 +0100
commit4f3ee302b76ac9fa403caa7d1c51124932c969a0 (patch)
tree19b7327f8f9bf01b1f0324c06720be2200198795
parent903789d60689101b39aed3dabf90406d4197dfa6 (diff)
parent00d5f189543f795291ab55522879dd80e2fce954 (diff)
downloadrust-4f3ee302b76ac9fa403caa7d1c51124932c969a0.tar.gz
rust-4f3ee302b76ac9fa403caa7d1c51124932c969a0.zip
Rollup merge of #118397 - Zalathar:nonzero, r=WaffleLapkin
Fix comments for unsigned non-zero `checked_add`, `saturating_add`

While looking at #118313, I happened to notice that two of the expanded comments appear to be slightly inaccurate.

For these two methods, `other` is an ordinary unsigned integer, so it can be zero.

Since the sum of non-zero and zero is always non-zero, the safety argument holds even when `other` is zero.
-rw-r--r--library/core/src/num/nonzero.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/library/core/src/num/nonzero.rs b/library/core/src/num/nonzero.rs
index 530221c237c..f5ecf501ce9 100644
--- a/library/core/src/num/nonzero.rs
+++ b/library/core/src/num/nonzero.rs
@@ -355,7 +355,7 @@ macro_rules! nonzero_unsigned_operations {
                     if let Some(result) = self.get().checked_add(other) {
                         // SAFETY:
                         // - `checked_add` returns `None` on overflow
-                        // - `self` and `other` are non-zero
+                        // - `self` is non-zero
                         // - the only way to get zero from an addition without overflow is for both
                         //   sides to be zero
                         //
@@ -393,7 +393,7 @@ macro_rules! nonzero_unsigned_operations {
                 pub const fn saturating_add(self, other: $Int) -> $Ty {
                     // SAFETY:
                     // - `saturating_add` returns `u*::MAX` on overflow, which is non-zero
-                    // - `self` and `other` are non-zero
+                    // - `self` is non-zero
                     // - the only way to get zero from an addition without overflow is for both
                     //   sides to be zero
                     //