Skip to content

Commit 29b6828

Browse files
mmiratejswrenn
andauthored
Update src/lib.rs
Co-authored-by: Jack Wrenn <[email protected]>
1 parent d118414 commit 29b6828

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/lib.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1608,11 +1608,12 @@ pub trait Itertools : Iterator {
16081608
None
16091609
}
16101610

1611-
/// Check whether the iterator contains an item.
1611+
/// Returns `true` if the given item is present in this iterator.
16121612
///
1613-
/// If the iterator contains the item prior to its end,
1614-
/// this method will short-circuit and only partially
1615-
/// exhaust the iterator.
1613+
/// This method is short-circuiting. If the given item is present in this
1614+
/// iterator, the this method will consume the iterator up-to-and-including
1615+
/// the item. If the given item is not present in this iterator, the
1616+
/// iterator will be exhausted.
16161617
///
16171618
/// ```
16181619
/// use itertools::Itertools;

0 commit comments

Comments
 (0)