Auto merge of #82680 - jturner314:div_euclid-docs, r=JohnTitor

Fix inequality in docs for div_euclid

This commit fixes the statement of the inequality that the Euclidean remainder satisfies. (The remainder is guaranteed to be less than abs(rhs), not rhs.) It also rewords the documentation to make it a little easier to read.

(You might wonder why I've written `abs(rhs)` instead of `rhs.abs()`. Two reasons: first, the `rem_euclid` docs use `abs(rhs)` instead of `rhs.abs()`, and second, the absolute value here is the mathematical absolute value, not the the `.abs()` operation which may overflow.)
This commit is contained in:
bors 2021-03-22 09:37:50 +00:00
commit 7f82ddb875
1 changed files with 4 additions and 4 deletions

View File

@ -1589,11 +1589,11 @@ macro_rules! int_impl {
/// Calculates the quotient of Euclidean division of `self` by `rhs`.
///
/// This computes the integer `n` such that `self = n * rhs + self.rem_euclid(rhs)`,
/// with `0 <= self.rem_euclid(rhs) < rhs`.
/// This computes the integer `q` such that `self = q * rhs + r`, with
/// `r = self.rem_euclid(rhs)` and `0 <= r < abs(rhs)`.
///
/// In other words, the result is `self / rhs` rounded to the integer `n`
/// such that `self >= n * rhs`.
/// In other words, the result is `self / rhs` rounded to the integer `q`
/// such that `self >= q * rhs`.
/// If `self > 0`, this is equal to round towards zero (the default in Rust);
/// if `self < 0`, this is equal to round towards +/- infinity.
///