[gnue] r6989 - trunk/gnue-appserver/src

[johannes]

Author: johannes
Date: 2005-02-10 13:51:57 -0600 (Thu, 10 Feb 2005)
New Revision: 6989

Modified:
   trunk/gnue-appserver/src/geasSession.py
Log:
Added missing comments


Modified: trunk/gnue-appserver/src/geasSession.py
===================================================================
--- trunk/gnue-appserver/src/geasSession.py     2005-02-10 19:20:10 UTC (rev 
6988)
+++ trunk/gnue-appserver/src/geasSession.py     2005-02-10 19:51:57 UTC (rev 
6989)
@@ -399,11 +399,16 @@
 
 
   # ---------------------------------------------------------------------------
-  #
+  # Transform a given item to a proper sort-element dictionary
   # ---------------------------------------------------------------------------
 
   def __getSortElement (self, item):
     """
+    This function converts the given sortelement to a properly defined
+    sort-item-dictionary.
+
+    @param item: sort-element in any form (string, list, tuple, dict, ...)
+    @return: dictionary with three keys: 'name', 'descending', 'ignorecase'
     """
 
     result = {'name': None, 'descending': False, 'ignorecase': False}