[Checkins] SVN: Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py Ref docstrings in interface.

Tres Seaver tseaver at palladion.com
Wed Mar 17 08:17:22 EDT 2010


Log message for revision 110017:
  Ref docstrings in interface.

Changed:
  U   Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py

-=-
Modified: Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py
===================================================================
--- Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py	2010-03-17 11:24:05 UTC (rev 110016)
+++ Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py	2010-03-17 12:17:21 UTC (rev 110017)
@@ -273,7 +273,7 @@
 
     ## IRecentItemsIndex implementation
     def getItemCounts(self):
-        """ Return a mapping of field values => item counts.
+        """ See IRecentItemsIndex.
         """
         counts = {}
         for value, items in self._value2items.items():
@@ -281,21 +281,7 @@
         return counts
 
     def query(self, value=None, limit=None, merge=1):
-        """ Return a lazy sequence of catalog brains like a catalog search.
-
-        Return results in order, newest first, for the value(s) given.
-
-        If 'value' is omitted, return the most recent for all values.
-        
-        'limit', if passed, must be an integer value restricting the maximum
-        number of results.
-        
-        If no limit is specified, use the 'max_length' of the index as
-        the limit.
-
-        'merge' is a flag:  if true, return a lazy map of the brains.  If
-        false, return a sequence of (value, rid, fetch) tuples which can
-        be merged later.
+        """ See IRecentItemsIndex.
         """
         catalog = aq_parent(aq_inner(self))
         if value is None and self.field_name is not None:



More information about the checkins mailing list