[postprocessor:metadata] rename 'format' to 'content-format'

Just to be consistent with the other 'extension-format' option name,
and only 'format' is also still accepted.
This commit is contained in:
Mike Fährmann
2019-11-30 17:27:49 +01:00
parent a412531451
commit 26d2334550
2 changed files with 6 additions and 5 deletions

View File

@@ -1465,8 +1465,8 @@ Description Select how to write metadata.
* ``"json"``: all metadata using `json.dump()
<https://docs.python.org/3/library/json.html#json.dump>`_
* ``"tags"``: ``tags`` separated by newlines
* ``"custom"``: result of applying `metadata.format`_ to a file's
metadata dictionary
* ``"custom"``: result of applying `metadata.content-format`_
to a file's metadata dictionary
=========== =====
metadata.extension
@@ -1490,8 +1490,8 @@ Description Custom format string to build filename extensions for metadata
Note: `metadata.extension`_ is ignored if this option is set.
=========== =====
metadata.format
---------------
metadata.content-format
-----------------------
=========== =====
Type ``string``
Example ``"tags:\n\n{tags:J\n}\n"``