Rollup merge of rust-lang#91859 - xkr47:patch-2, r=yaahc

Iterator::cycle() — document empty iterator special case
matthiaskrgr · Dec 14, 2021 · 3fc0a01 · 3fc0a01
2 parents bc3a4b0 + 715c562
commit 3fc0a01
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/library/core/src/iter/traits/iterator.rs b/library/core/src/iter/traits/iterator.rs
@@ -3028,7 +3028,8 @@ pub trait Iterator {
     ///
     /// Instead of stopping at [`None`], the iterator will instead start again,
     /// from the beginning. After iterating again, it will start at the
-    /// beginning again. And again. And again. Forever.
+    /// beginning again. And again. And again. Forever. Note that in case the
+    /// original iterator is empty, the resulting iterator will also be empty.
     ///
     /// # Examples
     ///