From 2c2163538246ad528e57e87db021d7528060aa65 Mon Sep 17 00:00:00 2001 From: Kevin Reid Date: Fri, 18 Aug 2023 08:09:00 -0700 Subject: Add `modulo` and `mod` as doc aliases for `rem_euclid`. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- library/std/src/f32.rs | 1 + library/std/src/f64.rs | 1 + 2 files changed, 2 insertions(+) (limited to 'library/std') diff --git a/library/std/src/f32.rs b/library/std/src/f32.rs index a53b8535213..3b74febc20d 100644 --- a/library/std/src/f32.rs +++ b/library/std/src/f32.rs @@ -321,6 +321,7 @@ impl f32 { /// // limitation due to round-off error /// assert!((-f32::EPSILON).rem_euclid(3.0) != 0.0); /// ``` + #[doc(alias = "modulo", alias = "mod")] #[rustc_allow_incoherent_impl] #[must_use = "method returns a new number and does not mutate the original value"] #[inline] diff --git a/library/std/src/f64.rs b/library/std/src/f64.rs index a1cec22c97a..4c068a7a7ab 100644 --- a/library/std/src/f64.rs +++ b/library/std/src/f64.rs @@ -321,6 +321,7 @@ impl f64 { /// // limitation due to round-off error /// assert!((-f64::EPSILON).rem_euclid(3.0) != 0.0); /// ``` + #[doc(alias = "modulo", alias = "mod")] #[rustc_allow_incoherent_impl] #[must_use = "method returns a new number and does not mutate the original value"] #[inline] -- cgit 1.4.1-3-g733a5