From fa2a54a54c64073120a74043af5564affbc7a8b5 Mon Sep 17 00:00:00 2001 From: Christiaan Biesterbosch Date: Thu, 13 Jun 2024 11:46:42 +0200 Subject: [PATCH] Fix wording in {checked_}next_power_of_two --- core/src/num/nonzero.rs | 2 +- core/src/num/uint_macros.rs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/core/src/num/nonzero.rs b/core/src/num/nonzero.rs index 863f0d61df374..5956a08593ad4 100644 --- a/core/src/num/nonzero.rs +++ b/core/src/num/nonzero.rs @@ -1059,7 +1059,7 @@ macro_rules! nonzero_integer_signedness_dependent_methods { unsafe { Self::new_unchecked(self.get().unchecked_add(other)) } } - /// Returns the smallest power of two greater than or equal to n. + /// Returns the smallest power of two greater than or equal to `self`. /// Checks for overflow and returns [`None`] /// if the next power of two is greater than the type’s maximum value. /// As a consequence, the result cannot wrap to zero. diff --git a/core/src/num/uint_macros.rs b/core/src/num/uint_macros.rs index 1491c27372bfb..cdbd695008e86 100644 --- a/core/src/num/uint_macros.rs +++ b/core/src/num/uint_macros.rs @@ -2830,7 +2830,7 @@ macro_rules! uint_impl { /// /// When return value overflows (i.e., `self > (1 << (N-1))` for type /// `uN`), it panics in debug mode and the return value is wrapped to 0 in - /// release mode (the only situation in which method can return 0). + /// release mode (the only situation in which this method can return 0). /// /// # Examples /// @@ -2851,7 +2851,7 @@ macro_rules! uint_impl { self.one_less_than_next_power_of_two() + 1 } - /// Returns the smallest power of two greater than or equal to `n`. If + /// Returns the smallest power of two greater than or equal to `self`. If /// the next power of two is greater than the type's maximum value, /// `None` is returned, otherwise the power of two is wrapped in `Some`. ///