Add comment about overflow behavior for next_power_of_two

rust-lang · Apr 28, 2017 · 67684a3 · 67684a3
1 parent 8f9caff
commit 67684a3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/libcore/num/mod.rs b/src/libcore/num/mod.rs
@@ -2340,6 +2340,9 @@ macro_rules! uint_impl {
         }
 
         /// Returns the smallest power of two greater than or equal to `self`.
+        /// When return value overflows, it panics in debug mode and return
+        /// value is wrapped in release mode.
+        ///
         /// More details about overflow behavior can be found in [RFC 560].
         ///
         /// # Examples