Skip to content

Commit 5354d14

Browse files
jfot-cpudunkla
authored andcommitted
Document separator deprecation in lastgenre plugin
Addresses PR beetbox#6169 review comment about separator configuration. Changes: - Updated "Multiple Genres" section in lastgenre docs to explain that genres are now stored as a list and written as individual tags - Added deprecation notice for the separator config option (deprecated in version 2.6) with explanation that it has no effect - Added changelog entry documenting the separator deprecation The separator option is now deprecated as genres are stored natively as lists in the genres field and written to files as separate genre tags rather than being joined with a separator. Note: Migration logic to handle existing separator-joined genre strings will be implemented as part of the database migration changes.
1 parent 74386ce commit 5354d14

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/changelog.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@ Other changes:
111111
unavailable, enabling ``importorskip`` usage in pytest setup.
112112
- Finally removed gmusic plugin and all related code/docs as the Google Play
113113
Music service was shut down in 2020.
114+
- :doc:`plugins/lastgenre`: The ``separator`` configuration option is
115+
deprecated. Genres are now stored as a list in the ``genres`` field and
116+
written to files as individual genre tags. The separator option has no effect
117+
and will be removed in a future version.
114118

115119
2.5.1 (October 14, 2025)
116120
------------------------

docs/plugins/lastgenre.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,8 @@ By default, the plugin chooses the most popular tag on Last.fm as a genre. If
9090
you prefer to use a *list* of popular genre tags, you can increase the number of
9191
the ``count`` config option.
9292

93-
Lists of up to *count* genres will then be used instead of single genres. The
94-
genres are separated by commas by default, but you can change this with the
95-
``separator`` config option.
93+
Lists of up to *count* genres will be stored in the ``genres`` field as a list
94+
and written to your media files as separate genre tags.
9695

9796
Last.fm_ provides a popularity factor, a.k.a. *weight*, for each tag ranging
9897
from 100 for the most popular tag down to 0 for the least popular. The plugin
@@ -192,7 +191,16 @@ file. The available options are:
192191
Default: ``no``.
193192
- **source**: Which entity to look up in Last.fm. Can be either ``artist``,
194193
``album`` or ``track``. Default: ``album``.
195-
- **separator**: A separator for multiple genres. Default: ``', '``.
194+
- **separator**:
195+
196+
.. deprecated:: 2.6
197+
198+
The ``separator`` option is deprecated. Genres are now stored as a list in
199+
the ``genres`` field and written to files as individual genre tags. This
200+
option has no effect and will be removed in a future version.
201+
202+
Default: ``', '``.
203+
196204
- **whitelist**: The filename of a custom genre list, ``yes`` to use the
197205
internal whitelist, or ``no`` to consider all genres valid. Default: ``yes``.
198206
- **title_case**: Convert the new tags to TitleCase before saving. Default:

0 commit comments

Comments
 (0)