Skip to content

Commit

Permalink
Fix clippy::doc_markdown warnings. (#1474)
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys authored Jul 20, 2024
1 parent e4874a6 commit f3aab23
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 5 deletions.
2 changes: 2 additions & 0 deletions clippy.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Don't warn about these identifiers when using clippy::doc_markdown.
doc-valid-idents = ["ChaCha", "ChaCha12", "SplitMix64", "ZiB", ".."]
2 changes: 1 addition & 1 deletion rand_core/src/block.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
/// [`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.
///
/// [`next_u32`]: RngCore::next_u32
Expand Down
2 changes: 1 addition & 1 deletion src/distributions/other.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
macro_rules! tuple_impl {
($($tyvar:ident)*) => {
Expand Down
4 changes: 2 additions & 2 deletions src/distributions/uniform.rs
Original file line number Diff line number Diff line change
Expand Up @@ -371,8 +371,8 @@ impl<X: SampleUniform> TryFrom<RangeInclusive<X>> for Uniform<X> {
}

/// Helper trait similar to [`Borrow`] but implemented
/// only for SampleUniform and references to SampleUniform in
/// order to resolve ambiguity issues.
/// only for [`SampleUniform`] and references to [`SampleUniform`]
/// in order to resolve ambiguity issues.
///
/// [`Borrow`]: std::borrow::Borrow
pub trait SampleBorrow<Borrowed> {
Expand Down
2 changes: 1 addition & 1 deletion src/seq/index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ where
/// which will be called once for each index.
///
/// 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.
///
/// Error cases:
Expand Down

0 comments on commit f3aab23

Please sign in to comment.