Various fixes to wording consistency in the docs

This commit is contained in:
Stjepan Glavina
2017-03-22 01:42:23 +01:00
parent cab4bff3de
commit d6da1d9b46
18 changed files with 61 additions and 62 deletions

View File

@@ -148,14 +148,14 @@ macro_rules! define_bignum {
$name { size: sz, base: base }
}
/// Return the internal digits as a slice `[a, b, c, ...]` such that the numeric
/// Returns the internal digits as a slice `[a, b, c, ...]` such that the numeric
/// value is `a + b * 2^W + c * 2^(2W) + ...` where `W` is the number of bits in
/// the digit type.
pub fn digits(&self) -> &[$ty] {
&self.base[..self.size]
}
/// Return the `i`-th bit where bit 0 is the least significant one.
/// Returns the `i`-th bit where bit 0 is the least significant one.
/// In other words, the bit with weight `2^i`.
pub fn get_bit(&self, i: usize) -> u8 {
use mem;
@@ -166,7 +166,7 @@ macro_rules! define_bignum {
((self.base[d] >> b) & 1) as u8
}
/// Returns true if the bignum is zero.
/// Returns `true` if the bignum is zero.
pub fn is_zero(&self) -> bool {
self.digits().iter().all(|&v| v == 0)
}

View File

@@ -2568,17 +2568,17 @@ pub trait Float: Sized {
implementable outside the standard library")]
fn one() -> Self;
/// Returns true if this value is NaN and false otherwise.
/// Returns `true` if this value is NaN and false otherwise.
#[stable(feature = "core", since = "1.6.0")]
fn is_nan(self) -> bool;
/// Returns true if this value is positive infinity or negative infinity and
/// Returns `true` if this value is positive infinity or negative infinity and
/// false otherwise.
#[stable(feature = "core", since = "1.6.0")]
fn is_infinite(self) -> bool;
/// Returns true if this number is neither infinite nor NaN.
/// Returns `true` if this number is neither infinite nor NaN.
#[stable(feature = "core", since = "1.6.0")]
fn is_finite(self) -> bool;
/// Returns true if this number is neither zero, infinite, denormal, or NaN.
/// Returns `true` if this number is neither zero, infinite, denormal, or NaN.
#[stable(feature = "core", since = "1.6.0")]
fn is_normal(self) -> bool;
/// Returns the category that this number falls into.