about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTrevor Spiteri <tspiteri@ieee.org>2018-01-09 12:26:00 +0100
committerTrevor Spiteri <tspiteri@ieee.org>2018-01-09 12:26:00 +0100
commit6d82e7814f1a387c0510ee525c6e0ac8fa890c40 (patch)
treeed09872c9f0fd31eadd4e1a49a7681f2c92be2a9
parent0eba4c206a3c47c375cb9ead20d37cf00f6351cf (diff)
downloadrust-6d82e7814f1a387c0510ee525c6e0ac8fa890c40.tar.gz
rust-6d82e7814f1a387c0510ee525c6e0ac8fa890c40.zip
remove implementation detail from doc
-rw-r--r--src/libstd/f32.rs4
-rw-r--r--src/libstd/f64.rs4
2 files changed, 4 insertions, 4 deletions
diff --git a/src/libstd/f32.rs b/src/libstd/f32.rs
index 8a15f19e440..5e5695f15ac 100644
--- a/src/libstd/f32.rs
+++ b/src/libstd/f32.rs
@@ -470,9 +470,9 @@ impl f32 {
         return unsafe { intrinsics::logf32(self) };
     }
 
-    /// Returns the logarithm of the number with respect to an arbitrary base,
-    /// calculated as `self.ln() / base.ln()`.
+    /// Returns the logarithm of the number with respect to an arbitrary base.
     ///
+    /// The result may not be correctly rounded owing to implementation details;
     /// `self.log2()` can produce more accurate results for base 2, and
     /// `self.log10()` can produce more accurate results for base 10.
     ///
diff --git a/src/libstd/f64.rs b/src/libstd/f64.rs
index 33f447b794c..e4eea745bb7 100644
--- a/src/libstd/f64.rs
+++ b/src/libstd/f64.rs
@@ -430,9 +430,9 @@ impl f64 {
         self.log_wrapper(|n| { unsafe { intrinsics::logf64(n) } })
     }
 
-    /// Returns the logarithm of the number with respect to an arbitrary base,
-    /// calculated as `self.ln() / base.ln()`.
+    /// Returns the logarithm of the number with respect to an arbitrary base.
     ///
+    /// The result may not be correctly rounded owing to implementation details;
     /// `self.log2()` can produce more accurate results for base 2, and
     /// `self.log10()` can produce more accurate results for base 10.
     ///