comment on a non-obvious function

diff --git a/doc/todo/sort_parameter_for_map_plugin_and_directive/python_algorithms.py b/doc/todo/sort_parameter_for_map_plugin_and_directive/python_algorithms.py
index ccee8185d090316b83ddf783c5223ed70204fbe9..894c5212e0a773107261b9681d2c3f92a8ed57de 100644 (file)
--- a/doc/todo/sort_parameter_for_map_plugin_and_directive/python_algorithms.py
+++ b/doc/todo/sort_parameter_for_map_plugin_and_directive/python_algorithms.py
@@ -35,6 +35,12 @@ def strategy_byparents(sequence):
     """
 
     def partindices(item):
     """
 
     def partindices(item):

+        """Convert an entry a tuple of the indices of the entry's parts.
+
+        >>> sequence = testsequence
+        >>> assert partindices("c/2/x") == (sequence.index("c"), sequence.index("c/2"), sequence.index("c/2/x"))
+        fnord
+        """

         return tuple(sequence.index(item.rsplit('/', i)[0]) for i in range(item.count('/'), -1, -1))
 
     return sorted(sequence, key=partindices)
         return tuple(sequence.index(item.rsplit('/', i)[0]) for i in range(item.count('/'), -1, -1))
 
     return sorted(sequence, key=partindices)