Fix clippy::doc_markdown
warnings. (#1474)
This commit is contained in:
parent
e4874a6dd7
commit
f3aab23fba
2
clippy.toml
Normal file
2
clippy.toml
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
# Don't warn about these identifiers when using clippy::doc_markdown.
|
||||||
|
doc-valid-idents = ["ChaCha", "ChaCha12", "SplitMix64", "ZiB", ".."]
|
@ -276,7 +276,7 @@ impl<R: CryptoBlockRng + BlockRngCore<Item = u32>> CryptoRng for BlockRng<R> {}
|
|||||||
/// then the other half is then consumed, however both [`next_u64`] and
|
/// then the other half is then consumed, however both [`next_u64`] and
|
||||||
/// [`fill_bytes`] discard the rest of any half-consumed `u64`s when called.
|
/// [`fill_bytes`] discard the rest of any half-consumed `u64`s when called.
|
||||||
///
|
///
|
||||||
/// [`fill_bytes`] `] consume a whole number of `u64` values. If the requested length
|
/// [`fill_bytes`] consumes a whole number of `u64` values. If the requested length
|
||||||
/// is not a multiple of 8, some bytes will be discarded.
|
/// is not a multiple of 8, some bytes will be discarded.
|
||||||
///
|
///
|
||||||
/// [`next_u32`]: RngCore::next_u32
|
/// [`next_u32`]: RngCore::next_u32
|
||||||
|
@ -189,7 +189,7 @@ where
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Implement `Distribution<(A, B, C, ...)> for Standard, using the list of
|
/// Implement `Distribution<(A, B, C, ...)> for Standard`, using the list of
|
||||||
/// identifiers
|
/// identifiers
|
||||||
macro_rules! tuple_impl {
|
macro_rules! tuple_impl {
|
||||||
($($tyvar:ident)*) => {
|
($($tyvar:ident)*) => {
|
||||||
|
@ -371,8 +371,8 @@ impl<X: SampleUniform> TryFrom<RangeInclusive<X>> for Uniform<X> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Helper trait similar to [`Borrow`] but implemented
|
/// Helper trait similar to [`Borrow`] but implemented
|
||||||
/// only for SampleUniform and references to SampleUniform in
|
/// only for [`SampleUniform`] and references to [`SampleUniform`]
|
||||||
/// order to resolve ambiguity issues.
|
/// in order to resolve ambiguity issues.
|
||||||
///
|
///
|
||||||
/// [`Borrow`]: std::borrow::Borrow
|
/// [`Borrow`]: std::borrow::Borrow
|
||||||
pub trait SampleBorrow<Borrowed> {
|
pub trait SampleBorrow<Borrowed> {
|
||||||
|
@ -339,7 +339,7 @@ where
|
|||||||
/// which will be called once for each index.
|
/// which will be called once for each index.
|
||||||
///
|
///
|
||||||
/// This implementation uses the algorithm described by Efraimidis and Spirakis
|
/// This implementation uses the algorithm described by Efraimidis and Spirakis
|
||||||
/// in this paper: https://doi.org/10.1016/j.ipl.2005.11.003
|
/// in this paper: <https://doi.org/10.1016/j.ipl.2005.11.003>
|
||||||
/// It uses `O(length + amount)` space and `O(length)` time.
|
/// It uses `O(length + amount)` space and `O(length)` time.
|
||||||
///
|
///
|
||||||
/// Error cases:
|
/// Error cases:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user