Skip to content

Commit

Permalink
Fix clippy::doc_markdown lint
Browse files Browse the repository at this point in the history
Only two changes are in public documentation.
  • Loading branch information
Philippe-Cholet authored and jswrenn committed May 13, 2024
1 parent 0fcc6d1 commit 5a8ab88
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions src/format.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use std::fmt;
/// See [`.format_with()`](crate::Itertools::format_with) for more information.
pub struct FormatWith<'a, I, F> {
sep: &'a str,
/// FormatWith uses interior mutability because Display::fmt takes &self.
/// `FormatWith` uses interior mutability because `Display::fmt` takes `&self`.
inner: Cell<Option<(I, F)>>,
}

Expand All @@ -22,7 +22,7 @@ pub struct FormatWith<'a, I, F> {
/// for more information.
pub struct Format<'a, I> {
sep: &'a str,
/// Format uses interior mutability because Display::fmt takes &self.
/// `Format` uses interior mutability because `Display::fmt` takes `&self`.
inner: Cell<Option<I>>,
}

Expand Down
5 changes: 3 additions & 2 deletions src/groupbylazy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,13 @@ where
/// Least index for which we still have elements buffered
oldest_buffered_group: usize,
/// Group index for `buffer[0]` -- the slots
/// bottom_group..oldest_buffered_group are unused and will be erased when
/// `bottom_group..oldest_buffered_group` are unused and will be erased when
/// that range is large enough.
bottom_group: usize,
/// Buffered groups, from `bottom_group` (index 0) to `top_group`.
buffer: Vec<vec::IntoIter<I::Item>>,
/// index of last group iter that was dropped, usize::MAX == none
/// index of last group iter that was dropped,
/// `usize::MAX` initially when no group was dropped
dropped_group: usize,
}

Expand Down
2 changes: 1 addition & 1 deletion src/grouping_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ where
/// If several elements are equally maximum, the last element is picked.
/// If several elements are equally minimum, the first element is picked.
///
/// See [.minmax()](crate::Itertools::minmax) for the non-grouping version.
/// See [`Itertools::minmax`](crate::Itertools::minmax) for the non-grouping version.
///
/// Differences from the non grouping version:
/// - It never produces a `MinMaxResult::NoElements`
Expand Down
5 changes: 2 additions & 3 deletions src/ziptuple.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pub struct Zip<T> {
t: T,
}

/// An iterator that generalizes *.zip()* and allows running multiple iterators in lockstep.
/// An iterator that generalizes `.zip()` and allows running multiple iterators in lockstep.
///
/// The iterator `Zip<(I, J, ..., M)>` is formed from a tuple of iterators (or values that
/// implement [`IntoIterator`]) and yields elements
Expand All @@ -20,7 +20,7 @@ pub struct Zip<T> {
/// ..)>` of each component iterator `I, J, ...`) if each component iterator is
/// nameable.
///
/// Prefer [`izip!()`] over `multizip` for the performance benefits of using the
/// Prefer [`izip!()`](crate::izip) over `multizip` for the performance benefits of using the
/// standard library `.zip()`. Prefer `multizip` if a nameable type is needed.
///
/// ```
Expand All @@ -36,7 +36,6 @@ pub struct Zip<T> {
///
/// assert_eq!(results, [0 + 3, 10 + 7, 29, 36]);
/// ```
/// [`izip!()`]: crate::izip
pub fn multizip<T, U>(t: U) -> Zip<T>
where
Zip<T>: From<U> + Iterator,
Expand Down

0 comments on commit 5a8ab88

Please sign in to comment.