Iterator::cycle() — document empty iterator special case

2021-12-13 13:23:33 +02:00 · 2021-12-13 13:23:33 +02:00 · 7f2f9c60c2
parent 6d6d0899c8
commit 7f2f9c60c2
1 changed files with 2 additions and 1 deletions
--- 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
    ///