aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsobolevn <mail@sobolevn.me>2024-08-03 10:58:48 +0300
committerLouis Pilfold <louis@lpil.uk>2024-08-13 19:27:10 +0200
commit94b80cd6fe27a2d5a212104587427f70c59ba87a (patch)
treeff1568ee8e376a7ddb8c54db0f8ca742433a28e2
parent78c0ca754100ca2f7e701a0d49f2f9d435337a83 (diff)
downloadgleam_stdlib-94b80cd6fe27a2d5a212104587427f70c59ba87a.tar.gz
gleam_stdlib-94b80cd6fe27a2d5a212104587427f70c59ba87a.zip
Add doctest to `iterator.repeatedly`
-rw-r--r--src/gleam/iterator.gleam8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/gleam/iterator.gleam b/src/gleam/iterator.gleam
index f0fef0d..ee38bdc 100644
--- a/src/gleam/iterator.gleam
+++ b/src/gleam/iterator.gleam
@@ -82,10 +82,16 @@ pub fn unfold(
|> Iterator
}
-// TODO: test
/// Creates an iterator that yields values created by calling a given function
/// repeatedly.
///
+/// ```gleam
+/// repeatedly(fn() { 7 })
+/// |> take(3)
+/// |> to_list
+/// // -> [7, 7, 7]
+/// ```
+///
pub fn repeatedly(f: fn() -> element) -> Iterator(element) {
unfold(Nil, fn(_) { Next(f(), Nil) })
}