[Checkins] SVN: Products.ZCatalog/trunk/src/Products/ZCatalog/Catalog.py update doc string for sortResults

Hano Schlichting cvs-admin at zope.org
Sat Apr 7 17:59:52 UTC 2012


Log message for revision 125084:
  update doc string for sortResults
  

Changed:
  U   Products.ZCatalog/trunk/src/Products/ZCatalog/Catalog.py

-=-
Modified: Products.ZCatalog/trunk/src/Products/ZCatalog/Catalog.py
===================================================================
--- Products.ZCatalog/trunk/src/Products/ZCatalog/Catalog.py	2012-04-07 16:08:38 UTC (rev 125083)
+++ Products.ZCatalog/trunk/src/Products/ZCatalog/Catalog.py	2012-04-07 17:59:45 UTC (rev 125084)
@@ -662,9 +662,11 @@
 
     def sortResults(self, rs, sort_index, reverse=False, limit=None,
             merge=True, actual_result_count=None, b_start=0, b_size=None):
-        # Sort a result set using a sort index. Return a lazy
-        # result set in sorted order if merge is true otherwise
-        # returns a list of (sortkey, uid, getter_function) tuples
+        # Sort a result set using one or more sort indexes. Both sort_index
+        # and reverse can be lists of indexes and reverse specifications.
+        # Return a lazy result set in sorted order if merge is true otherwise
+        # returns a list of (sortkey, uid, getter_function) tuples, where
+        # sortkey can be a tuple on its own.
         index2 = None
         sort_index_length = 1
         if isinstance(sort_index, list):



More information about the checkins mailing list