diff options
author | Giacomo Cavalieri <giacomo.cavalieri@icloud.com> | 2023-08-31 10:03:30 +0200 |
---|---|---|
committer | Louis Pilfold <louis@lpil.uk> | 2023-09-04 12:50:50 +0100 |
commit | 979f0d5d5bc9b149978ab88a6df64019b302d0e3 (patch) | |
tree | 2b67a7ca4c09c7b0b527679e97c304f0f062f3c8 | |
parent | 33f90d57604b0ee4483c1b1f3fa82d92a9abf5a4 (diff) | |
download | gleam_stdlib-979f0d5d5bc9b149978ab88a6df64019b302d0e3.tar.gz gleam_stdlib-979f0d5d5bc9b149978ab88a6df64019b302d0e3.zip |
review comments
-rw-r--r-- | src/gleam/iterator.gleam | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/src/gleam/iterator.gleam b/src/gleam/iterator.gleam index 1718600..5865646 100644 --- a/src/gleam/iterator.gleam +++ b/src/gleam/iterator.gleam @@ -421,7 +421,7 @@ fn do_flatten(flattened: fn() -> Action(Iterator(a))) -> Action(a) { } } -/// Joins an iterator of iterators into a single iterator. +/// Flattens an iterator of iterators, creating a new iterator. /// /// This function does not evaluate the elements of the iterator, the /// computation is performed when the iterator is later run. @@ -431,7 +431,6 @@ fn do_flatten(flattened: fn() -> Action(Iterator(a))) -> Action(a) { /// ```gleam /// > from_list([[1, 2], [3, 4]]) /// > |> map(from_list) -/// > |> from_list /// > |> flatten /// > |> to_list /// [1, 2, 3, 4] |