about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJubilee Young <workingjubilee@gmail.com>2023-08-12 02:13:37 -0700
committerJubilee Young <workingjubilee@gmail.com>2023-08-12 02:13:41 -0700
commit90dc2f839b05bf0467bac71d9be738eab6423dc7 (patch)
tree8e178d9464c28b90a51dce30e086cbfa75422dde
parenta6f8aa5a092c5e46fcbdafe4c80b4e55ba0de41c (diff)
downloadrust-90dc2f839b05bf0467bac71d9be738eab6423dc7.tar.gz
rust-90dc2f839b05bf0467bac71d9be738eab6423dc7.zip
Name what ln_gamma does
The previous description omitted some important details.
-rw-r--r--library/std/src/f32.rs4
-rw-r--r--library/std/src/f64.rs4
2 files changed, 6 insertions, 2 deletions
diff --git a/library/std/src/f32.rs b/library/std/src/f32.rs
index a53b8535213..878b13581ac 100644
--- a/library/std/src/f32.rs
+++ b/library/std/src/f32.rs
@@ -978,7 +978,9 @@ impl f32 {
         unsafe { cmath::tgammaf(self) }
     }
 
-    /// Returns the natural logarithm of the gamma function.
+    /// Natural logarithm of the absolute value of the gamma function
+    ///
+    /// The integer part of the tuple indicates the sign of the gamma function.
     ///
     /// # Examples
     ///
diff --git a/library/std/src/f64.rs b/library/std/src/f64.rs
index a1cec22c97a..e12cdb1b4ec 100644
--- a/library/std/src/f64.rs
+++ b/library/std/src/f64.rs
@@ -978,7 +978,9 @@ impl f64 {
         unsafe { cmath::tgamma(self) }
     }
 
-    /// Returns the natural logarithm of the gamma function.
+    /// Natural logarithm of the absolute value of the gamma function
+    ///
+    /// The integer part of the tuple indicates the sign of the gamma function.
     ///
     /// # Examples
     ///