From 9e851041d7b7631217857067f80b461543844c24 Mon Sep 17 00:00:00 2001
From: Ralf Jung <post@ralfj.de>
Date: Fri, 14 Jun 2024 11:18:32 +0200
Subject: [PATCH] div_euclid, rem_euclid: clarify/extend documentation
---
library/core/src/num/int_macros.rs | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/library/core/src/num/int_macros.rs b/library/core/src/num/int_macros.rs
index 55bb6166f1017..4488948496398 100644
--- a/library/core/src/num/int_macros.rs
+++ b/library/core/src/num/int_macros.rs
@@ -2784,8 +2784,10 @@ macro_rules! int_impl {
///
/// 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.
+ /// If `self > 0`, this is equal to rounding towards zero (the default in Rust);
+ /// if `self < 0`, this is equal to rounding away from zero (towards +/- infinity).
+ /// If `rhs > 0`, this is equal to rounding towards -infinity;
+ /// if `rhs < 0`, this is equal to rounding towards +infinity.
///
/// # Panics
///
@@ -2823,8 +2825,8 @@ macro_rules! int_impl {
/// Calculates the least nonnegative remainder of `self (mod rhs)`.
///
/// This is done as if by the Euclidean division algorithm -- given
- /// `r = self.rem_euclid(rhs)`, `self = rhs * self.div_euclid(rhs) + r`, and
- /// `0 <= r < abs(rhs)`.
+ /// `r = self.rem_euclid(rhs)`, the result satisfies
+ /// `self = rhs * self.div_euclid(rhs) + r` and `0 <= r < abs(rhs)`.
///
/// # Panics
///