Clarify Panicking Behavior in Integer Division Docs

This commit is contained in:
Nicholas Thompson 2024-01-19 15:33:19 -05:00
parent 6b8eae0d24
commit 76659ae743
2 changed files with 8 additions and 19 deletions

View File

@ -2152,7 +2152,8 @@ macro_rules! int_impl {
/// ///
/// # Panics /// # Panics
/// ///
/// This function will panic if `rhs` is 0 or the division results in overflow. /// This function will panic if `rhs` is 0 or if `self` is -1 and `rhs` is
/// `Self::MIN`. This behavior is not affected by the `overflow-checks` flag.
/// ///
/// # Examples /// # Examples
/// ///
@ -2190,7 +2191,8 @@ macro_rules! int_impl {
/// ///
/// # Panics /// # Panics
/// ///
/// This function will panic if `rhs` is 0 or the division results in overflow. /// This function will panic if `rhs` is 0 or if `self` is -1 and `rhs` is
/// `Self::MIN`. This behavior is not affected by the `overflow-checks` flag.
/// ///
/// # Examples /// # Examples
/// ///
@ -2233,12 +2235,8 @@ macro_rules! int_impl {
/// ///
/// # Panics /// # Panics
/// ///
/// This function will panic if `rhs` is zero. /// This function will panic if `rhs` is 0 or if `self` is -1 and `rhs` is
/// /// `Self::MIN`. This behavior is not affected by the `overflow-checks` flag.
/// ## Overflow behavior
///
/// On overflow, this function will panic if overflow checks are enabled (default in debug
/// mode) and wrap if overflow checks are disabled (default in release mode).
/// ///
/// # Examples /// # Examples
/// ///
@ -2273,12 +2271,8 @@ macro_rules! int_impl {
/// ///
/// # Panics /// # Panics
/// ///
/// This function will panic if `rhs` is zero. /// This function will panic if `rhs` is 0 or if `self` is -1 and `rhs` is
/// /// `Self::MIN`. This behavior is not affected by the `overflow-checks` flag.
/// ## Overflow behavior
///
/// On overflow, this function will panic if overflow checks are enabled (default in debug
/// mode) and wrap if overflow checks are disabled (default in release mode).
/// ///
/// # Examples /// # Examples
/// ///

View File

@ -2138,11 +2138,6 @@ macro_rules! uint_impl {
/// ///
/// This function will panic if `rhs` is zero. /// This function will panic if `rhs` is zero.
/// ///
/// ## Overflow behavior
///
/// On overflow, this function will panic if overflow checks are enabled (default in debug
/// mode) and wrap if overflow checks are disabled (default in release mode).
///
/// # Examples /// # Examples
/// ///
/// Basic usage: /// Basic usage: