about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJack Huey <31162821+jackh726@users.noreply.github.com>2021-09-08 12:24:21 -0400
committerGitHub <noreply@github.com>2021-09-08 12:24:21 -0400
commitbd6ce72ecea338df3de01d5d31f3693044796df0 (patch)
tree46eaac6b8c3c2c8b73c24d8034187148621eb20e
parent7d51dae2f83a6ee8c1f9a51a48bffabdece6826d (diff)
parent56bb6f5a25e8babe1cba540f9935032b0f4941ce (diff)
downloadrust-bd6ce72ecea338df3de01d5d31f3693044796df0.tar.gz
rust-bd6ce72ecea338df3de01d5d31f3693044796df0.zip
Rollup merge of #88712 - jhpratt:fix-int_rounding-docs, r=joshtriplett
Fix docs for `uX::checked_next_multiple_of`

Thanks to `@photino` for noticing this [here](https://github.com/rust-lang/rust/issues/88581#issuecomment-913982246).

r? `@joshtriplett`

`@rustbot` label: +A-docs +A-waiting-on-review
-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 46e64c33b84..b6bb06f9d64 100644
--- a/library/core/src/num/uint_macros.rs
+++ b/library/core/src/num/uint_macros.rs
@@ -1924,7 +1924,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
         ///