Merge #534

534: Clarify how `next()` interacts with `peek()` in` MultiPeek`. r=phimuemue a=b05902132

While intuitively this is the most reasonable behavior, it's nice to document it.

Co-authored-by: b05902132 <32428261+b05902132@users.noreply.github.com>

Author: bors[bot]

src/multipeek_impl.rs

@@ -38,6 +38,7 @@ impl<I: Iterator> MultiPeek<I> {
     /// Works exactly like `.next()` with the only difference that it doesn't
     /// advance itself. `.peek()` can be called multiple times, to peek
     /// further ahead.
+    /// When `.next()` is called, reset the peeking “cursor”.
     pub fn peek(&mut self) -> Option<&I::Item> {
         let ret = if self.index < self.buf.len() {
             Some(&self.buf[self.index])