Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-28 03:22:39 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3339 from octos/master

Browse source 
improve readability
This commit is contained in:
Adrian Sampson 2019-08-01 09:31:48 -04:00
commit 345e0d5315
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/plugins/zero.rst
View file

@ -5,9 +5,10 @@ The ``zero`` plugin allows you to null fields in files' metadata tags. Fields
can be nulled unconditionally or conditioned on a pattern match. For example,
the plugin can strip useless comments like "ripped by MyGreatRipper."
The plugin can work in one of two modes. The first mode, the default, is a
blacklist, where you choose the tags you want to remove. The second mode is a
whitelist, where you instead specify the tags you want to keep.
The plugin can work in one of two modes:
* ``fields`` - a blacklist, where you choose the tags you want to remove (used by default).
* ``keep_fields`` - a whitelist, where you instead specify the tags you want to keep.
To use the ``zero`` plugin, enable the plugin in your configuration
(see :ref:`using-plugins`).
@ -20,17 +21,17 @@ fields to nullify and the conditions for nullifying them:
* Set ``auto`` to ``yes`` to null fields automatically on import.
Default: ``yes``.
* Set ``fields`` to a whitespace-separated list of fields to change. You can
* Set ``fields`` to a whitespace-separated list of fields to remove. You can
get the list of all available fields by running ``beet fields``. In
addition, the ``images`` field allows you to remove any images
embedded in the media file.
* Set ``keep_fields`` to *invert* the logic of the plugin. Only these fields
will be kept; other fields will be removed. Remember to set only
``fields`` or ``keep_fields``---not both!
``fields`` or ``keep_fields`` -- not both!
* To conditionally filter a field, use ``field: [regexp, regexp]`` to specify
regular expressions.
* By default this plugin only affects files' tags ; the beets database is left
unchanged. To update the tags in the database, set the ``update_database`` option.
* By default this plugin only affects files' tags; the beets database is left
unchanged. To update the tags in the database, set the ``update_database`` option to true.
For example::