Skip to content

Commit

Permalink
Canonicalize some free functions (5) multipeek: documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
phimuemue committed Dec 22, 2021
1 parent 08ea4c4 commit 8e73e5d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/multipeek_impl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ use std::iter::Fuse;
use alloc::collections::VecDeque;
use crate::size_hint;
use crate::PeekingNext;
#[cfg(doc)]
use crate::Itertools;

/// See [`multipeek()`] for more information.
#[derive(Clone, Debug)]
Expand All @@ -15,6 +17,8 @@ pub struct MultiPeek<I>

/// An iterator adaptor that allows the user to peek at multiple `.next()`
/// values without advancing the base iterator.
///
/// [`IntoIterator`] enabled version of [`Itertools::multipeek`].
pub fn multipeek<I>(iterable: I) -> MultiPeek<I::IntoIter>
where I: IntoIterator
{
Expand Down

0 comments on commit 8e73e5d

Please sign in to comment.