Skip to content

Commit 567c48e

Browse files
committed
DOC: Update izip!() docs for type changes
1 parent 77d8efd commit 567c48e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/lib.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,12 +210,15 @@ macro_rules! iproduct {
210210
/// returns `None`.
211211
///
212212
/// This is a version of the standard ``.zip()`` that's supporting more than
213-
/// two iterators. The iterator elment type is a tuple with one element
213+
/// two iterators. The iterator element type is a tuple with one element
214214
/// from each of the input iterators. Just like ``.zip()``, the iteration stops
215215
/// when the shortest of the inputs reaches its end.
216216
///
217-
/// **Note:** The result of this macro is an iterator composed of
218-
/// repeated `.zip()` and a `.map()`; it has an anonymous type.
217+
/// **Note:** The result of this macro is in the general case an iterator
218+
/// composed of repeated `.zip()` and a `.map()`; it has an anonymous type.
219+
/// The special cases of one and two arguments produce the equivalent of
220+
/// `$a.into_iter()` and `$a.into_iter().zip($b)` respectively.
221+
///
219222
/// Prefer this macro `izip!()` over [`multizip`] for the performance benefits
220223
/// of using the standard library `.zip()`.
221224
///

0 commit comments

Comments
 (0)