From 29200d34dcb72cd9030e442e2d55bfc75d7bf117 Mon Sep 17 00:00:00 2001 From: sarabande Date: Sat, 1 Mar 2025 16:21:41 -0700 Subject: [PATCH] docs(iterator): update Cycle function documentation (#128) --- iterator/stateless/cycle.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/iterator/stateless/cycle.go b/iterator/stateless/cycle.go index 4528d16..0e318ba 100644 --- a/iterator/stateless/cycle.go +++ b/iterator/stateless/cycle.go @@ -19,8 +19,7 @@ import ( G "github.com/IBM/fp-go/iterator/stateless/generic" ) -// DropWhile creates an [Iterator] that drops elements from the [Iterator] as long as the predicate is true; afterwards, returns every element. -// Note, the [Iterator] does not produce any output until the predicate first becomes false +// Cycle creates an [Iterator] containing an [Iterator] repeated an infinite number of times. func Cycle[U any](ma Iterator[U]) Iterator[U] { return G.Cycle[Iterator[U]](ma) }