From: Jean Privat <jean@pryen.org>
Date: Wed, 26 Nov 2014 01:33:37 +0000 (-0500)
Subject: lib/pipeline: add a missing docunit
X-Git-Tag: v0.6.11~9^2~5
X-Git-Url: http://nitlanguage.org

lib/pipeline: add a missing docunit

Signed-off-by: Jean Privat <jean@pryen.org>
---

diff --git a/lib/pipeline.nit b/lib/pipeline.nit
index 31d007b..be553ad 100644
--- a/lib/pipeline.nit
+++ b/lib/pipeline.nit
@@ -14,9 +14,8 @@
 
 # Pipelined filters and operations on iterators.
 #
-# This module enhance `Iterator`s with some methods that enable a
-# pipeline-like programing that offers the manupulation of
-# collections trough connected filters with reasonable memory constraints.
+# This module enhances `Iterator` with some methods that enable a pipeline-like programing.
+# The processing of elements in a pipeline is done trough connected filters that are implemented with reasonable memory constraints.
 module pipeline
 
 redef interface Iterator[E]
@@ -35,6 +34,8 @@ redef interface Iterator[E]
 
 	# Filter: sort with a given `comparator`.
 	# Important: require O(n) memory.
+	#
+	#    assert ["a", "c", "b"].iterator.sort_with(alpha_comparator).to_a  == ["a", "b", "c"]
 	fun sort_with(comparator: Comparator): Iterator[E]
 	do
 		var a = self.to_a