dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #88713 - falk-hueffner:int-log10-documentation-fixes, r=scottmcm 

Improve docs for int_log

* Clarify rounding.
* Avoid "wrapping" wording.
* Omit wrong claim on 0 only being returned in error cases.
* Typo fix for one_less_than_next_power_of_two.
This commit is contained in:
Matthias Krüger 2021-10-10 18:22:18 +02:00 committed by GitHub
parent fd5bed73d0 138ebd19c6
commit 4473b945bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
library/core/src/num/int_macros.rs
View File

@ -2199,7 +2199,8 @@ macro_rules! int_impl {
}
}
/// Returns the logarithm of the number with respect to an arbitrary base.
/// Returns the logarithm of the number with respect to an arbitrary base,
/// rounded down.
///
/// This method might not be optimized owing to implementation details;
/// `log2` can produce results more efficiently for base 2, and `log10`
@ -2208,8 +2209,8 @@ macro_rules! int_impl {
/// # Panics
///
/// When the number is zero, or if the base is not at least 2; it
/// panics in debug mode and the return value is wrapped to 0 in release
/// mode (the only situation in which the method can return 0).
/// panics in debug mode and the return value is 0 in release
/// mode.
///
/// # Examples
///
@ -2237,13 +2238,12 @@ macro_rules! int_impl {
}
}
/// Returns the base 2 logarithm of the number.
/// Returns the base 2 logarithm of the number, rounded down.
///
/// # Panics
///
/// When the number is zero it panics in debug mode and the return value
/// is wrapped to 0 in release mode (the only situation in which the
/// method can return 0).
/// is 0 in release mode.
///
/// # Examples
///
@ -2271,13 +2271,12 @@ macro_rules! int_impl {
}
}
/// Returns the base 10 logarithm of the number.
/// Returns the base 10 logarithm of the number, rounded down.
///
/// # Panics
///
/// When the number is zero it panics in debug mode and the return value
/// is wrapped to 0 in release mode (the only situation in which the
/// method can return 0).
/// is 0 in release mode.
///
/// # Example
///
@ -2305,7 +2304,8 @@ macro_rules! int_impl {
}
}
/// Returns the logarithm of the number with respect to an arbitrary base.
/// Returns the logarithm of the number with respect to an arbitrary base,
/// rounded down.
///
/// Returns `None` if the number is negative or zero, or if the base is not at least 2.
///
@ -2345,7 +2345,7 @@ macro_rules! int_impl {
}
}
/// Returns the base 2 logarithm of the number.
/// Returns the base 2 logarithm of the number, rounded down.
///
/// Returns `None` if the number is negative or zero.
///
@ -2369,7 +2369,7 @@ macro_rules! int_impl {
}
}
/// Returns the base 10 logarithm of the number.
/// Returns the base 10 logarithm of the number, rounded down.
///
/// Returns `None` if the number is negative or zero.
///

25
library/core/src/num/uint_macros.rs
View File

@ -658,7 +658,8 @@ macro_rules! uint_impl {
}
}
/// Returns the logarithm of the number with respect to an arbitrary base.
/// Returns the logarithm of the number with respect to an arbitrary base,
/// rounded down.
///
/// This method might not be optimized owing to implementation details;
/// `log2` can produce results more efficiently for base 2, and `log10`
@ -667,8 +668,7 @@ macro_rules! uint_impl {
/// # Panics
///
/// When the number is negative, zero, or if the base is not at least 2;
/// it panics in debug mode and the return value is wrapped to 0 in
/// release mode (the only situation in which the method can return 0).
/// it panics in debug mode and the return value is 0 in release mode.
///
/// # Examples
///
@ -696,13 +696,12 @@ macro_rules! uint_impl {
}
}
/// Returns the base 2 logarithm of the number.
/// Returns the base 2 logarithm of the number, rounded down.
///
/// # Panics
///
/// When the number is negative or zero it panics in debug mode and
/// the return value is wrapped to 0 in release mode (the only situation in
/// which the method can return 0).
/// the return value is 0 in release mode.
///
/// # Examples
///
@ -730,13 +729,12 @@ macro_rules! uint_impl {
}
}
/// Returns the base 10 logarithm of the number.
/// Returns the base 10 logarithm of the number, rounded down.
///
/// # Panics
///
/// When the number is negative or zero it panics in debug mode and the
/// return value is wrapped to 0 in release mode (the only situation in
/// which the method can return 0).
/// return value is 0 in release mode.
///
/// # Example
///
@ -764,7 +762,8 @@ macro_rules! uint_impl {
}
}
/// Returns the logarithm of the number with respect to an arbitrary base.
/// Returns the logarithm of the number with respect to an arbitrary base,
/// rounded down.
///
/// Returns `None` if the number is zero, or if the base is not at least 2.
///
@ -804,7 +803,7 @@ macro_rules! uint_impl {
}
}
/// Returns the base 2 logarithm of the number.
/// Returns the base 2 logarithm of the number, rounded down.
///
/// Returns `None` if the number is zero.
///
@ -828,7 +827,7 @@ macro_rules! uint_impl {
}
}
/// Returns the base 10 logarithm of the number.
/// Returns the base 10 logarithm of the number, rounded down.
///
/// Returns `None` if the number is zero.
///
@ -2120,7 +2119,7 @@ macro_rules! uint_impl {
/// Returns the smallest power of two greater than or equal to `self`.
///
/// When return value overflows (i.e., `self > (1 << (N-1))` for type
/// `uN`), it panics in debug mode and return value is wrapped to 0 in
/// `uN`), it panics in debug mode and the return value is wrapped to 0 in
/// release mode (the only situation in which method can return 0).
///
/// # Examples