Update documentation

This commit is contained in:
Julien Cretin
2020-11-11 17:52:33 +01:00
parent d3ee698d69
commit c6f9270be1

View File

@@ -80,7 +80,11 @@ impl Entropy<'_> {
result
}
/// Reads a bounded number.
/// Reads a number between `min` and `max` (inclusive bounds).
///
/// The distribution is uniform if the range width is a power of two. Otherwise, the minimum
/// amount of entropy is used (the next power of two) and the distribution is the closest to
/// uniform for that entropy.
///
/// # Preconditions
///