about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-04-16 14:25:58 +0200
committerGitHub <noreply@github.com>2022-04-16 14:25:58 +0200
commitbd007ba9289cb34eed38476dfde2886a3ce576da (patch)
tree454a7ad759cc832dd31fada924965e5e2f14e002
parentce30f5cd1ac332163273cd416ce6f85ee74660d5 (diff)
parentd73e32867f45690720c17422b83c8abc8ceff645 (diff)
downloadrust-bd007ba9289cb34eed38476dfde2886a3ce576da.tar.gz
rust-bd007ba9289cb34eed38476dfde2886a3ce576da.zip
Rollup merge of #96038 - beyarkay:patch-1, r=m-ou-se
docs: add link from zip to unzip

The docs for `Iterator::unzip` explain that it is kind of an inverse operation to `Iterator::zip` and guide the reader to the `zip` docs, but the `zip` docs don't let the user know that they can undo the `zip` operation with `unzip`. This change modifies the docs to help the user find `unzip`.
-rw-r--r--library/core/src/iter/traits/iterator.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/library/core/src/iter/traits/iterator.rs b/library/core/src/iter/traits/iterator.rs
index 53fbe4cbc42..69f06fb06ef 100644
--- a/library/core/src/iter/traits/iterator.rs
+++ b/library/core/src/iter/traits/iterator.rs
@@ -470,6 +470,10 @@ pub trait Iterator {
     /// it will first try to advance the first iterator at most one time and if it still yielded an item
     /// try to advance the second iterator at most one time.
     ///
+    /// To 'undo' the result of zipping up two iterators, see [`unzip`].
+    ///
+    /// [`unzip`]: Iterator::unzip
+    ///
     /// # Examples
     ///
     /// Basic usage: