Skip to content

Commit 9a1582c

Browse files
Improve storage/filesystem docs
add hints about how to use the `fileext` and `fileignoreext` parameters.
1 parent 9b5e01a commit 9a1582c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/config.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,13 +422,15 @@ Local
422422
:param fileext: The file extension to use (e.g. ``.txt``). Contained in the
423423
href, so if you change the file extension after a sync, this will
424424
trigger a re-download of everything (but *should* not cause data-loss
425-
of any kind).
425+
of any kind). To be compatible with the ``vset to the empty string`` format you have
426+
to either use ``.vcf`` or ``.ics``. Note that metasync won't work
427+
if you use an empty string here.
426428
:param encoding: File encoding for items, both content and filename.
427429
:param post_hook: A command to call for each item creation and
428430
modification. The command will be called with the path of the
429431
new/updated file.
430-
:param fileeignoreext: The file extention to ignore,
431-
the default is ``.tmp``.
432+
:param fileeignoreext: The file extention to ignore. It is only useful
433+
if fileext is set to the empty string. The default is ``.tmp``.
432434

433435
.. storage:: singlefile
434436

0 commit comments

Comments
 (0)