From 203c2176d91a2160e056b6bac17a3b8011164810 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0ar=C5=ABnas=20Nejus?= Date: Sun, 5 Oct 2025 20:02:14 +0100 Subject: [PATCH] Update data_source_penalty docs --- docs/plugins/index.rst | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 1374475cc..1e2f5d5e8 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -47,21 +47,27 @@ some, you can use ``pip``'s "extras" feature to install the dependencies: Using Metadata Source Plugins ----------------------------- -Some plugins provide sources for metadata in addition to MusicBrainz. These -plugins share the following configuration option: +We provide several :ref:`autotagger_extensions` that fetch metadata from online +databases. They share the following configuration options: - **data_source_mismatch_penalty**: Penalty applied to matches during import. - Set to 0.0 to disable. Default: ``0.0``. + Default: ``0.0`` (no penalty). -For example, to equally consider matches from Discogs and MusicBrainz add the -following to your configuration: + Penalize this data source to prioritize others. For example, to prefer Discogs + over MusicBrainz: -.. code-block:: yaml + .. code-block:: yaml - plugins: musicbrainz discogs + plugins: musicbrainz discogs - discogs: - data_source_mismatch_penalty: 0.0 + musicbrainz: + data_source_mismatch_penalty: 2.0 + + By default, all sources are equally preferred with each having + ``data_source_mismatch_penalty`` set to ``0.0``. + +- **search_limit**: Maximum number of search results to consider. Default: + ``5``. .. toctree:: :hidden: