[CalendarServer-changes] [10056] CalendarServer/branches/users/glyph/one-home-list-api
source_changes at macosforge.org
source_changes at macosforge.org
Fri Nov 16 14:48:53 PST 2012
Revision: 10056
http://trac.calendarserver.org//changeset/10056
Author: glyph at apple.com
Date: 2012-11-16 14:48:52 -0800 (Fri, 16 Nov 2012)
Log Message:
-----------
minor docstring formatting fix
Modified Paths:
--------------
CalendarServer/branches/users/glyph/one-home-list-api/twistedcaldav/directory/idirectory.py
Property Changed:
----------------
CalendarServer/branches/users/glyph/one-home-list-api/
Modified: CalendarServer/branches/users/glyph/one-home-list-api/twistedcaldav/directory/idirectory.py
===================================================================
--- CalendarServer/branches/users/glyph/one-home-list-api/twistedcaldav/directory/idirectory.py 2012-11-16 22:48:51 UTC (rev 10055)
+++ CalendarServer/branches/users/glyph/one-home-list-api/twistedcaldav/directory/idirectory.py 2012-11-16 22:48:52 UTC (rev 10056)
@@ -102,20 +102,21 @@
"""
@param tokens: The tokens to search on
@type tokens: C{list} of C{str} (utf-8 bytes)
- @param context: An indication of what the end user is searching
- for; "attendee", "location", or None
+
+ @param context: An indication of what the end user is searching for;
+ "attendee", "location", or None
@type context: C{str}
- @return: a deferred sequence of L{IDirectoryRecord}s which
- match the given tokens and optional context.
- Each token is searched for within each record's full name and
- email address; if each token is found within a record that
- record is returned in the results.
+ @return: a deferred sequence of L{IDirectoryRecord}s which match the
+ given tokens and optional context.
- If context is None, all record types are considered. If
- context is "location", only locations are considered. If
- context is "attendee", only users, groups, and resources
- are considered.
+ Each token is searched for within each record's full name and email
+ address; if each token is found within a record that record is
+ returned in the results.
+
+ If context is None, all record types are considered. If context is
+ "location", only locations are considered. If context is
+ "attendee", only users, groups, and resources are considered.
"""
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20121116/db88bb08/attachment.html>
More information about the calendarserver-changes
mailing list