From 979f0d5d5bc9b149978ab88a6df64019b302d0e3 Mon Sep 17 00:00:00 2001
From: Giacomo Cavalieri <giacomo.cavalieri@icloud.com>
Date: Thu, 31 Aug 2023 10:03:30 +0200
Subject: review comments

---
 src/gleam/iterator.gleam | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'src')

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]
-- 
cgit v1.2.3