-

cool-RR · cool-RR · commit 8e9821473aaa · 2012-12-24T01:43:37.000+02:00
diff --git a/python_toolbox/comparison_tools.py b/python_toolbox/comparison_tools.py
@@ -56,6 +56,14 @@ def total_ordering(cls):
 
 
 def process_key_function_or_attribute_name(key_function_or_attribute_name):
+    '''
+    Make a key function given either a key function or an attribute name.
+    
+    Some functions let you sort stuff by entering a key function or an
+    attribute name by which the elements will be sorted. This function tells
+    whether we were given a key function or an attribute name, and generates a
+    key function out of it if needed.
+    '''
     if key_function_or_attribute_name is None:
         return None
     elif callable(key_function_or_attribute_name):
