Skip to content

Commit

Permalink
Final lastgenre docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
JOJ0 committed Jan 8, 2025
1 parent f97b9ce commit d8ce25a
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/plugins/lastgenre.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,10 @@ To *overwrite* any content of pre-populated tags, set ``force: yes`` and
``keep_existing: no``.

To *combine* newly fetched last.fm genres with any pre-existing ones, set
``force: yes``, ``keep_existing: yes`` but also disable the whitelist
(``whitelist: False``).
``force: yes``, ``keep_existing: yes`` and ``whitelist: False``.

Any combinations including ``force: no`` and ``keep_existing: yes`` is invalid
(since _not forcing_ means not touching existing tags anyway).
Combining ``force: no`` and ``keep_existing: yes`` is invalid

Check failure on line 131 in docs/plugins/lastgenre.rst

View workflow job for this annotation

GitHub Actions / Check docs

ERROR: Unknown target name: "touching".
(since _"not forcing"_ means _not touching_ existing tags anyway).

Configuration
-------------
Expand All @@ -150,12 +149,14 @@ configuration file. The available options are:
You can use the empty string ``''`` to reset the genre.
Default: None.
- **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`_).
Default: ``no``.
- **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
combination with an active ``force`` option.
on whether or not ``whitelist`` is enabled, existing genres get "a cleanup".
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``.
- **min_weight**: Minimum popularity factor below which genres are discarded.
Default: 10.
Expand Down

0 comments on commit d8ce25a

Please sign in to comment.