[Checkins] SVN: Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py Clarify docstring.

Tres Seaver tseaver at palladion.com
Wed Mar 17 07:19:05 EDT 2010


Log message for revision 110015:
  Clarify docstring.

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:01:56 UTC (rev 110014)
+++ Produts.RecentItemsIndex/trunk/Products/RecentItemsIndex/index.py	2010-03-17 11:19:04 UTC (rev 110015)
@@ -283,16 +283,14 @@
     def query(self, value=None, limit=None, merge=1):
         """ Return a lazy sequence of catalog brains like a catalog search.
 
-        Brains coorespond to the most recent items for the value(s) given.
+        Return results in order, newest first, for the value(s) given.
 
         If 'value' is omitted, return the most recent for all values.
-
-        The results are returned in order, newest first.
         
         'limit', if passed, must be an integer value restricting the maximum
         number of results.
         
-        If no limit is specified, the indexes' maximum length is used as
+        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



More information about the checkins mailing list