Final lastgenre docs changes

This commit is contained in:
J0J0 Todos 2025-01-08 18:23:01 +01:00
parent 37fc1b6b7f
commit a49f12b110

View file

@ -113,6 +113,7 @@ popular, which is often the most generic (in this case ``folk``). By setting
Handling pre-populated tags Handling pre-populated tags
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ``force``, ``keep_existing`` and ``whitelist`` options control how The ``force``, ``keep_existing`` and ``whitelist`` options control how
pre-existing genres are handled. pre-existing genres are handled.
@ -126,11 +127,10 @@ To *overwrite* any content of pre-populated tags, set ``force: yes`` and
``keep_existing: no``. ``keep_existing: no``.
To *combine* newly fetched last.fm genres with any pre-existing ones, set To *combine* newly fetched last.fm genres with any pre-existing ones, set
``force: yes``, ``keep_existing: yes`` but also disable the whitelist ``force: yes``, ``keep_existing: yes`` and ``whitelist: False``.
(``whitelist: False``).
Any combinations including ``force: no`` and ``keep_existing: yes`` is invalid Combining ``force: no`` and ``keep_existing: yes`` is invalid (since ``force:
(since _not forcing_ means not touching existing tags anyway). no`` means `not touching` existing tags anyway).
Configuration Configuration
------------- -------------
@ -150,12 +150,14 @@ configuration file. The available options are:
You can use the empty string ``''`` to reset the genre. You can use the empty string ``''`` to reset the genre.
Default: None. Default: None.
- **force**: By default, lastgenre will fetch new genres for empty as well as - **force**: By default, lastgenre will fetch new genres for empty as well as
pre-populated tags. Adjust the ``keep_existing`` option to combine existing pre-populated tags. Enable the ``keep_existing`` option to combine existing
and new genres. (see `Handling pre-populated tags`_). and new genres. (see `Handling pre-populated tags`_).
Default: ``no``. Default: ``no``.
- **keep_existing**: By default, genres remain in pre-populated tags. Depending - **keep_existing**: By default, genres remain in pre-populated tags. Depending
If a whitelist is in place, existing genres get a cleanup. Only valid in on whether or not ``whitelist`` is enabled, existing genres get "a cleanup".
combination with an active ``force`` option. Enabling ``keep_existing`` is only valid in combination with an active
``force`` option. To ensure only fresh last.fm genres, disable this option.
(see `Handling pre-populated tags`_)
Default: ``yes``. Default: ``yes``.
- **min_weight**: Minimum popularity factor below which genres are discarded. - **min_weight**: Minimum popularity factor below which genres are discarded.
Default: 10. Default: 10.