Skip to content

Commit 5faae38

Browse files
committed
apfloat: improve doc comments
1 parent 534b423 commit 5faae38

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/librustc_apfloat/lib.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -551,12 +551,13 @@ pub trait Float
551551
fn ilogb(self) -> ExpInt;
552552

553553
/// Returns: self * 2<sup>exp</sup> for integral exponents.
554+
/// Equivalent to C standard library function `ldexp`.
554555
fn scalbn_r(self, exp: ExpInt, round: Round) -> Self;
555556
fn scalbn(self, exp: ExpInt) -> Self {
556557
self.scalbn_r(exp, Round::NearestTiesToEven)
557558
}
558559

559-
/// Equivalent of C standard library function.
560+
/// Equivalent to C standard library function with the same name.
560561
///
561562
/// While the C standard says exp is an unspecified value for infinity and nan,
562563
/// this returns INT_MAX for infinities, and INT_MIN for NaNs (see `ilogb`).

0 commit comments

Comments
 (0)