[CalendarServer-changes] [6987] CalendarServer/branches/users/glyph/dalify/txdav/base/propertystore/ sql.py

[source_changes at macosforge.org]

Revision: 6987
          http://trac.macosforge.org/projects/calendarserver/changeset/6987
Author:   glyph at apple.com
Date:     2011-02-16 06:36:33 -0800 (Wed, 16 Feb 2011)
Log Message:
-----------
It doesn't return a list, so the docstring shouldn't start with 'return a list'.

Modified Paths:
--------------
    CalendarServer/branches/users/glyph/dalify/txdav/base/propertystore/sql.py

Modified: CalendarServer/branches/users/glyph/dalify/txdav/base/propertystore/sql.py
===================================================================
--- CalendarServer/branches/users/glyph/dalify/txdav/base/propertystore/sql.py	2011-02-16 14:36:22 UTC (rev 6986)
+++ CalendarServer/branches/users/glyph/dalify/txdav/base/propertystore/sql.py	2011-02-16 14:36:33 UTC (rev 6987)
@@ -85,9 +85,9 @@
     def forMultipleResources(cls, defaultUser, txn,
                              childColumn, parentColumn, parentID):
         """
-        Return a list of property stores for all objects in a collection.  This
-        is used to optimize Depth:1 operations on that collection, by loading
-        all relevant properties in a single query.
+        Load all property stores for all objects in a collection.  This is used
+        to optimize Depth:1 operations on that collection, by loading all
+        relevant properties in a single query.
 
         @param defaultUser: the UID of the user who owns / is requesting the
             property stores; the ones whose per-user properties will be exposed.
@@ -106,6 +106,8 @@
             e.g. if childColumn is addressbook object's resource ID, then this
             should be addressbook's resource ID.
 
+        @return: a L{Deferred} that fires with a C{dict} mapping resource ID (a
+            value taken from C{childColumn}) to a L{PropertyStore} for that ID.
         """
         childTable = TableSyntax(childColumn.model.table)
         query = Select([
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20110216/dc5f953f/attachment.html>