diff options
| author | Kevin Reid <kpreid@switchb.org> | 2023-08-18 08:09:00 -0700 |
|---|---|---|
| committer | Kevin Reid <kpreid@switchb.org> | 2023-08-18 12:28:27 -0700 |
| commit | 2c2163538246ad528e57e87db021d7528060aa65 (patch) | |
| tree | 3e219a8f620051d57a272d6ddce25721a4794355 /library/core/src/num | |
| parent | b9177c0adb1ccae97145569c954696a4c680f5b3 (diff) | |
| download | rust-2c2163538246ad528e57e87db021d7528060aa65.tar.gz rust-2c2163538246ad528e57e87db021d7528060aa65.zip | |
Add `modulo` and `mod` as doc aliases for `rem_euclid`.
When I was learning Rust I looked for “a modulo function” and couldn’t find one, so thought I had to write my own; it wasn't at all obvious that a function with “rem” in the name was the function I wanted. Hopefully this will save the next learner from that. However, it does have the disadvantage that the top results in rustdoc for “mod” are now these aliases instead of the Rust keyword, which probably isn't ideal.
Diffstat (limited to 'library/core/src/num')
| -rw-r--r-- | library/core/src/num/int_macros.rs | 1 | ||||
| -rw-r--r-- | library/core/src/num/uint_macros.rs | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/library/core/src/num/int_macros.rs b/library/core/src/num/int_macros.rs index 1199d09b563..1f43520e1b3 100644 --- a/library/core/src/num/int_macros.rs +++ b/library/core/src/num/int_macros.rs @@ -2126,6 +2126,7 @@ macro_rules! int_impl { /// assert_eq!(a.rem_euclid(-b), 3); /// assert_eq!((-a).rem_euclid(-b), 1); /// ``` + #[doc(alias = "modulo", alias = "mod")] #[stable(feature = "euclidean_division", since = "1.38.0")] #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")] #[must_use = "this returns the result of the operation, \ diff --git a/library/core/src/num/uint_macros.rs b/library/core/src/num/uint_macros.rs index 2136d29255f..81148c7cc51 100644 --- a/library/core/src/num/uint_macros.rs +++ b/library/core/src/num/uint_macros.rs @@ -2024,6 +2024,7 @@ macro_rules! uint_impl { /// ``` #[doc = concat!("assert_eq!(7", stringify!($SelfT), ".rem_euclid(4), 3); // or any other integer type")] /// ``` + #[doc(alias = "modulo", alias = "mod")] #[stable(feature = "euclidean_division", since = "1.38.0")] #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")] #[must_use = "this returns the result of the operation, \ |