lib/collection: better doc for Iterator
authorAlexis Laferrière <alexis.laf@xymus.net>
Tue, 14 Apr 2015 20:55:48 +0000 (16:55 -0400)
committerAlexis Laferrière <alexis.laf@xymus.net>
Tue, 28 Apr 2015 17:24:41 +0000 (13:24 -0400)
Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

lib/standard/collection/abstract_collection.nit

index 1b1e71e..2f7e454 100644 (file)
@@ -179,8 +179,9 @@ interface Collection[E]
        end
 end
 
        end
 end
 
-# Instances of the Iterator class generates a series of elements, one at a time.
-# They are mainly used with collections.
+# Iterators generate a series of elements, one at a time.
+#
+# They are mainly used with collections and obtained from `Collection::iterator`.
 interface Iterator[E]
        # The current item.
        # Require `is_ok`.
 interface Iterator[E]
        # The current item.
        # Require `is_ok`.