Skip to content

Commit 8b22647

Browse files
henry-oberholtzerpeterjdolan
authored andcommitted
Fix musicbrainz plugin documentation (beetbox#6024)
Add several lines to documentation to clear up possible confusion on musicbrainz plugin being disabled when plugin list is modified. closes beetbox#6020
1 parent f70dce1 commit 8b22647

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed

docs/changelog.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ For packagers:
1515

1616
Other changes:
1717

18+
- :doc:`plugins/index`: Clarify that musicbrainz must be mentioned if plugin
19+
list modified :bug:`6020`
20+
- :doc:`/faq`: Add check for musicbrainz plugin if auto-tagger can't find a
21+
match :bug:`6020`
22+
- :doc:`guides/tagger`: Section on no matching release found, related to
23+
possibly disabled musicbrainz plugin :bug:`6020`
24+
1825
2.4.0 (September 13, 2025)
1926
--------------------------
2027

docs/faq.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,9 @@ Why does beets…
236236

237237
There are a number of possibilities:
238238

239-
- First, make sure the album is in `the MusicBrainz database
239+
- First, make sure you have at least one autotagger extension/plugin enabled.
240+
See :ref:`autotagger_extensions` for a list of valid plugins.
241+
- Check that the album is in `the MusicBrainz database
240242
<https://musicbrainz.org/>`__. You can search on their site to make sure it's
241243
cataloged there. (If not, anyone can edit MusicBrainz---so consider adding the
242244
data yourself.)

docs/guides/tagger.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,11 +289,21 @@ MusicBrainz---so consider adding the data yourself.
289289

290290
.. _the musicbrainz database: https://musicbrainz.org/
291291

292+
If you receive a "No matching release found" message from the Auto-Tagger for an
293+
album you know is present in MusicBrainz, check that musicbrainz is in the
294+
plugin list. Until version v2.4.0_ the default metadata source for the
295+
Auto-Tagger, the :doc:`musicbrainz plugin </plugins/musicbrainz>`, had to be
296+
manually disabled. At present, if the plugin list is changed, musicbrainz needs
297+
to be added to the plugin list in order to continue contributing results to
298+
Auto-Tagger.
299+
292300
If you think beets is ignoring an album that's listed in MusicBrainz, please
293301
`file a bug report`_.
294302

295303
.. _file a bug report: https://github.com/beetbox/beets/issues
296304

305+
.. _v2.4.0: https://github.com/beetbox/beets/releases/tag/v2.4.0
306+
297307
I Hope That Makes Sense
298308
-----------------------
299309

docs/plugins/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ list), just use the ``plugins`` option in your :doc:`config.yaml
1818

1919
.. code-block:: sh
2020
21-
plugins: inline convert web
21+
plugins: musicbrainz inline convert web
2222
2323
The value for ``plugins`` can be a space-separated list of plugin names or a
2424
YAML list like ``[foo, bar]``. You can see which plugins are currently enabled
@@ -29,7 +29,7 @@ its name:
2929

3030
.. code-block:: yaml
3131
32-
plugins: inline convert web
32+
plugins: musicbrainz inline convert web
3333
3434
convert:
3535
auto: true
@@ -58,7 +58,7 @@ following to your configuration:
5858

5959
.. code-block:: yaml
6060
61-
plugins: discogs
61+
plugins: musicbrainz discogs
6262
6363
discogs:
6464
source_weight: 0.0

0 commit comments

Comments
 (0)