Improve docs for item_types

This commit is contained in:
Markus Unterwaditzer 2015-02-14 18:31:27 +01:00
parent 8275d23635
commit c2fac4ac6f

View file

@ -526,11 +526,18 @@ class CaldavStorage(DavStorage):
Either both or none have to be specified. The default is to synchronize Either both or none have to be specified. The default is to synchronize
everything. everything.
You can set ``item_types`` to restrict the *kind of items* you want to
synchronize. For example, if you want to only synchronize events (but don't
download any tasks from the server), set ``item_types = ["VEVENT"]``. If
you want to synchronize events and tasks, but have some ``VJOURNAL`` items
on the server you don't want to synchronize, use ``item_types = ["VEVENT",
"VTODO"]``.
:param start_date: Start date of timerange to show, default -inf. :param start_date: Start date of timerange to show, default -inf.
:param end_date: End date of timerange to show, default +inf. :param end_date: End date of timerange to show, default +inf.
:param item_types: Comma-separated collection types to show from the :param item_types: Kind of items to show. The default, the empty list, is
server. Dependent on server functionality, no clientside validation of to show all. This depends on particular features on the server, the
results. The empty value ``[]`` means "all items". results are not validated.
''' + DavStorage.__doc__ ''' + DavStorage.__doc__
storage_name = 'caldav' storage_name = 'caldav'