about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2019-08-09 19:30:00 +0200
committerRalf Jung <post@ralfj.de>2019-08-09 19:33:02 +0200
commit5faae38851daea574b0b414618ec61a953bef2db (patch)
tree17eaa120c582b71fbfeebfa77cc53609ce670541
parent534b42394d743511db1335d5ed08d507ab7c6e73 (diff)
downloadrust-5faae38851daea574b0b414618ec61a953bef2db.tar.gz
rust-5faae38851daea574b0b414618ec61a953bef2db.zip
apfloat: improve doc comments
-rw-r--r--src/librustc_apfloat/lib.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/librustc_apfloat/lib.rs b/src/librustc_apfloat/lib.rs
index 9e6d5a6f624..2df4d2a4e9d 100644
--- a/src/librustc_apfloat/lib.rs
+++ b/src/librustc_apfloat/lib.rs
@@ -551,12 +551,13 @@ pub trait Float
     fn ilogb(self) -> ExpInt;
 
     /// Returns: self * 2<sup>exp</sup> for integral exponents.
+    /// Equivalent to C standard library function `ldexp`.
     fn scalbn_r(self, exp: ExpInt, round: Round) -> Self;
     fn scalbn(self, exp: ExpInt) -> Self {
         self.scalbn_r(exp, Round::NearestTiesToEven)
     }
 
-    /// Equivalent of C standard library function.
+    /// Equivalent to C standard library function with the same name.
     ///
     /// While the C standard says exp is an unspecified value for infinity and nan,
     /// this returns INT_MAX for infinities, and INT_MIN for NaNs (see `ilogb`).