Documentation tweaks for #2349

This commit is contained in:
Adrian Sampson 2016-12-28 12:03:57 -05:00
parent 2a3f3d9bfa
commit 8a62087376
2 changed files with 11 additions and 10 deletions

View file

@ -239,9 +239,9 @@ class AcousticPlugin(plugins.BeetsPlugin):
# composites attributes straight away and populating the dictionary
# `composites` with the composite attributes.
# When we are finished traversing `scheme`, `composites` should map
# each composite attribute to an ordered list of the values belonging to
# the attribute, for example:
# When we are finished traversing `scheme`, `composites` should
# map each composite attribute to an ordered list of the values
# belonging to the attribute, for example:
# `composites = {'initial_key': ['B', 'minor']}`.
# The recursive traversal.

View file

@ -10,10 +10,11 @@ Enable the ``acousticbrainz`` plugin in your configuration (see :ref:`using-plug
$ beet acousticbrainz [-f] [QUERY]
By default, the command will only look for acousticbrainz data when the tracks doesn't
already have it; the ``-f`` or ``--force`` switch makes it fetch acousticbrainz
for the item. If you specify a query, only matching tracks will be processed;
otherwise, the command processes every track in your library.
By default, the command will only look for AcousticBrainz data when the tracks
doesn't already have it; the ``-f`` or ``--force`` switch makes it re-download
data even when it already exists. If you specify a query, only matching tracks
will be processed; otherwise, the command processes every track in your
library.
For all tracks with a MusicBrainz recording ID, the plugin currently sets
these fields:
@ -57,6 +58,6 @@ configuration file. There is one option:
- **auto**: Enable AcousticBrainz during ``beet import``.
Default: ``yes``.
- **force**: By default, beets will not override already fetched acousticbrainz data. To instead fetch acousticbrainz and override data,
set the ``force`` option to ``yes``.
Default: ``no``.
- **force**: Download AcousticBrainz data even for tracks that already have
it.
Default: ``no``.