Final take on rewording rewrite plugin docs

on whether it modifies metadata or not. Let's also leave a link to the issue
here to make it superclear and researchable for anyone stumbling across it.

Also suggest the substitute plugin as an alternative.
This commit is contained in:
J0J0 Todos 2023-09-08 19:19:06 +02:00
parent 4f4e4cdc70
commit c185b4fba5

View file

@ -30,7 +30,9 @@ As a convenience, the plugin applies patterns for the ``artist`` field to the
``albumartist`` field as well. (Otherwise, you would probably want to duplicate
every rule for ``artist`` and ``albumartist``.)
Note that this plugin basically only applies to templating; it initially does
not modify files' metadata tags or the values tracked by beets' library
database, but since it rewrites all field lookups, it also might modify file's
metadata.
A word of warning: This plugin theoretically only applies to templates and path
formats; it initially does not modify files' metadata tags or the values
tracked by beets' library database, but since it *rewrites all field lookups*,
it modifies the file's metadata anyway. See comments in issue :bug:`2786`.
As an alternative to this plugin the :doc:`/plugins/substitute` could be used.