Clarify short-circuiting behvaior of Iterator::zip.

Fixes #52279.
rust-lang · Jul 18, 2018 · 2d4011d · 2d4011d
1 parent f686885
commit 2d4011d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/libcore/iter/iterator.rs b/src/libcore/iter/iterator.rs
@@ -384,7 +384,9 @@ pub trait Iterator {
     ///
     /// In other words, it zips two iterators together, into a single one.
     ///
-    /// If either iterator returns [`None`], [`next`] will return [`None`].
+    /// If either iterator returns [`None`], [`next`] from the zipped iterator
+    /// will return [`None`]. If the first iterator returns [`None`], `zip` will
+    /// short-circuit and `next` will not be called on the second iterator.
     ///
     /// # Examples
     ///