Skip to content

Commit 57e69e2

Browse files
committed
Auto merge of rust-lang#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.)
2 parents a5d7d65 + 4ad4526 commit 57e69e2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

core/src/num/int_macros.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,11 +1589,11 @@ macro_rules! int_impl {
15891589

15901590
/// Calculates the quotient of Euclidean division of `self` by `rhs`.
15911591
///
1592-
/// This computes the integer `n` such that `self = n * rhs + self.rem_euclid(rhs)`,
1593-
/// with `0 <= self.rem_euclid(rhs) < rhs`.
1592+
/// This computes the integer `q` such that `self = q * rhs + r`, with
1593+
/// `r = self.rem_euclid(rhs)` and `0 <= r < abs(rhs)`.
15941594
///
1595-
/// In other words, the result is `self / rhs` rounded to the integer `n`
1596-
/// such that `self >= n * rhs`.
1595+
/// In other words, the result is `self / rhs` rounded to the integer `q`
1596+
/// such that `self >= q * rhs`.
15971597
/// If `self > 0`, this is equal to round towards zero (the default in Rust);
15981598
/// if `self < 0`, this is equal to round towards +/- infinity.
15991599
///

0 commit comments

Comments
 (0)