Improve docs on filesystem's path param

This commit is contained in:
Markus Unterwaditzer 2015-04-06 12:55:52 +02:00
parent aaafbd5d14
commit 13408779cb

View file

@ -24,8 +24,9 @@ class FilesystemStorage(Storage):
Can be used with `khal <http://lostpackets.de/khal/>`_. See :doc:`vdir` for
a more formal description of the format.
:param path: Absolute path to a vdir or collection, depending on the
collection parameter (see :py:class:`vdirsyncer.storage.base.Storage`).
:param path: Absolute path to a vdir/collection. If this is used in
combination with the ``collections`` parameter in a pair-section, this
should point to a directory of vdirs instead.
:param fileext: The file extension to use (e.g. ``.txt``). Contained in the
href, so if you change the file extension after a sync, this will
trigger a re-download of everything (but *should* not cause data-loss