about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJacob Pratt <jacob@jhpratt.dev>2021-09-07 02:14:04 -0400
committerJacob Pratt <jacob@jhpratt.dev>2021-09-07 02:14:04 -0400
commit56bb6f5a25e8babe1cba540f9935032b0f4941ce (patch)
treed1face8cdbc85ecc57fbfe70ccedee43ec1347ec
parent371f3cd3fe523d0b398ed1db1620667c53ba7d02 (diff)
downloadrust-56bb6f5a25e8babe1cba540f9935032b0f4941ce.tar.gz
rust-56bb6f5a25e8babe1cba540f9935032b0f4941ce.zip
Fix docs for `uX::checked_next_multiple_of`
-rw-r--r--library/core/src/num/uint_macros.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/library/core/src/num/uint_macros.rs b/library/core/src/num/uint_macros.rs
index 02a5ed4ca80..7264088bb95 100644
--- a/library/core/src/num/uint_macros.rs
+++ b/library/core/src/num/uint_macros.rs
@@ -1927,7 +1927,8 @@ macro_rules! uint_impl {
         }
 
         /// Calculates the smallest value greater than or equal to `self` that
-        /// is a multiple of `rhs`. If `rhs` is negative,
+        /// is a multiple of `rhs`. Returns `None` is `rhs` is zero or the
+        /// operation would result in overflow.
         ///
         /// # Examples
         ///