src/pyams_utils/list.py
changeset 380 c062ab4db6cd
parent 337 d4e617c7e37a
child 408 cf2304af0fab
--- a/src/pyams_utils/list.py	Tue Jun 18 16:53:34 2019 +0200
+++ b/src/pyams_utils/list.py	Wed Jun 26 10:39:34 2019 +0200
@@ -10,6 +10,16 @@
 # FOR A PARTICULAR PURPOSE.
 #
 
+"""PyAMS_utils list module
+
+This module is dedicated to lists and iterators management. It provides function to extract
+unique values from a list or iterator in their original order, or to iterate over an iterator in
+random order; it also provides a "boolean_iter" function (usable as TALES extension) to check if
+an iterator returns at least one value, without consuming this iterator (the function returns a
+tuple containing a boolean value to specify if iterator is empty or not, and the original
+iterator).
+"""
+
 __docformat__ = 'restructuredtext'
 
 from itertools import filterfalse, tee