about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMarkus Mayer <widemeadows@gmail.com>2024-05-29 14:58:34 +0200
committerMarkus Mayer <widemeadows@gmail.com>2024-05-29 14:58:37 +0200
commit54bb08d53881da7c43b91fd5a6bd8ef9a3b754e6 (patch)
tree86212ba906ba66444145f4fd71f6b9f1f59d5ab7
parenteb729380499b12cb539d665221d5930a06467024 (diff)
downloadrust-54bb08d53881da7c43b91fd5a6bd8ef9a3b754e6.tar.gz
rust-54bb08d53881da7c43b91fd5a6bd8ef9a3b754e6.zip
Add FRAC_1_SQRT_2PI doc alias to FRAC_1_SQRT_TAU
This is create symmetry between the already existing TAU constant (2pi)
and the newly-introduced FRAC_1_SQRT_2PI, keeping the more common
name while increasing visibility.
-rw-r--r--library/core/src/num/f128.rs1
-rw-r--r--library/core/src/num/f16.rs1
-rw-r--r--library/core/src/num/f32.rs1
-rw-r--r--library/core/src/num/f64.rs1
4 files changed, 4 insertions, 0 deletions
diff --git a/library/core/src/num/f128.rs b/library/core/src/num/f128.rs
index 75eed264858..129f62fb43d 100644
--- a/library/core/src/num/f128.rs
+++ b/library/core/src/num/f128.rs
@@ -69,6 +69,7 @@ pub mod consts {
         0.564189583547756286948079451560772585844050629328998856844086_f128;
 
     /// 1/sqrt(2π)
+    #[doc(alias = "FRAC_1_SQRT_TAU")]
     #[unstable(feature = "f128", issue = "116909")]
     // Also, #[unstable(feature = "more_float_constants", issue = "103883")]
     pub const FRAC_1_SQRT_2PI: f128 =
diff --git a/library/core/src/num/f16.rs b/library/core/src/num/f16.rs
index 955314516a4..7a488cd6bf6 100644
--- a/library/core/src/num/f16.rs
+++ b/library/core/src/num/f16.rs
@@ -68,6 +68,7 @@ pub mod consts {
     pub const FRAC_1_SQRT_PI: f16 = 0.564189583547756286948079451560772586_f16;
 
     /// 1/sqrt(2π)
+    #[doc(alias = "FRAC_1_SQRT_TAU")]
     #[unstable(feature = "f16", issue = "116909")]
     // Also, #[unstable(feature = "more_float_constants", issue = "103883")]
     pub const FRAC_1_SQRT_2PI: f16 = 0.398942280401432677939946059934381868_f16;
diff --git a/library/core/src/num/f32.rs b/library/core/src/num/f32.rs
index 8c591af3c0d..8e9c7b4d11f 100644
--- a/library/core/src/num/f32.rs
+++ b/library/core/src/num/f32.rs
@@ -328,6 +328,7 @@ pub mod consts {
     pub const FRAC_1_SQRT_PI: f32 = 0.564189583547756286948079451560772586_f32;
 
     /// 1/sqrt(2π)
+    #[doc(alias = "FRAC_1_SQRT_TAU")]
     #[unstable(feature = "more_float_constants", issue = "103883")]
     pub const FRAC_1_SQRT_2PI: f32 = 0.398942280401432677939946059934381868_f32;
 
diff --git a/library/core/src/num/f64.rs b/library/core/src/num/f64.rs
index db458c4375c..5247897437a 100644
--- a/library/core/src/num/f64.rs
+++ b/library/core/src/num/f64.rs
@@ -328,6 +328,7 @@ pub mod consts {
     pub const FRAC_1_SQRT_PI: f64 = 0.564189583547756286948079451560772586_f64;
 
     /// 1/sqrt(2π)
+    #[doc(alias = "FRAC_1_SQRT_TAU")]
     #[unstable(feature = "more_float_constants", issue = "103883")]
     pub const FRAC_1_SQRT_2PI: f64 = 0.398942280401432677939946059934381868_f64;