Skip to content

Commit 76063e9

Browse files
authored
Unrolled build for #148935
Rollup merge of #148935 - Wilfred:fix_remainder_docs, r=Mark-Simulacrum Fix division syntax in doc comments `mod` is a keyword in Rust, and since we're talking about remainders we should be using division syntax here.
2 parents 5549523 + 95b5bba commit 76063e9

File tree

6 files changed

+12
-6
lines changed

6 files changed

+12
-6
lines changed

library/core/src/num/f128.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1753,7 +1753,8 @@ impl f128 {
17531753
q
17541754
}
17551755

1756-
/// Calculates the least nonnegative remainder of `self (mod rhs)`.
1756+
/// Calculates the least nonnegative remainder of `self` when
1757+
/// divided by `rhs`.
17571758
///
17581759
/// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
17591760
/// most cases. However, due to a floating point round-off error it can

library/core/src/num/f16.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1728,7 +1728,8 @@ impl f16 {
17281728
q
17291729
}
17301730

1731-
/// Calculates the least nonnegative remainder of `self (mod rhs)`.
1731+
/// Calculates the least nonnegative remainder of `self` when
1732+
/// divided by `rhs`.
17321733
///
17331734
/// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
17341735
/// most cases. However, due to a floating point round-off error it can

library/core/src/num/int_macros.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3147,7 +3147,8 @@ macro_rules! int_impl {
31473147
}
31483148

31493149

3150-
/// Calculates the least nonnegative remainder of `self (mod rhs)`.
3150+
/// Calculates the least nonnegative remainder of `self` when
3151+
/// divided by `rhs`.
31513152
///
31523153
/// This is done as if by the Euclidean division algorithm -- given
31533154
/// `r = self.rem_euclid(rhs)`, the result satisfies

library/core/src/num/uint_macros.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3481,7 +3481,8 @@ macro_rules! uint_impl {
34813481
}
34823482

34833483

3484-
/// Calculates the least remainder of `self (mod rhs)`.
3484+
/// Calculates the least remainder of `self` when divided by
3485+
/// `rhs`.
34853486
///
34863487
/// Since, for the positive integers, all common
34873488
/// definitions of division are equal, this

library/std/src/num/f32.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,8 @@ impl f32 {
252252
core::f32::math::div_euclid(self, rhs)
253253
}
254254

255-
/// Calculates the least nonnegative remainder of `self (mod rhs)`.
255+
/// Calculates the least nonnegative remainder of `self` when divided by
256+
/// `rhs`.
256257
///
257258
/// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
258259
/// most cases. However, due to a floating point round-off error it can

library/std/src/num/f64.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,8 @@ impl f64 {
252252
core::f64::math::div_euclid(self, rhs)
253253
}
254254

255-
/// Calculates the least nonnegative remainder of `self (mod rhs)`.
255+
/// Calculates the least nonnegative remainder of `self` when divided by
256+
/// `rhs`.
256257
///
257258
/// In particular, the return value `r` satisfies `0.0 <= r < rhs.abs()` in
258259
/// most cases. However, due to a floating point round-off error it can

0 commit comments

Comments
 (0)