Skip to content

Commit 29b77cf

Browse files
committed
Added changelog entry.
1 parent 3ce3363 commit 29b77cf

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/changelog.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,20 @@ For plugin developers:
6666
* The `fetchart` plugins has seen a few changes to function signatures and
6767
source registration in the process of introducing typings to the code.
6868
Custom art sources might need to be adapted.
69-
69+
* We split the responsibilities of plugins into two base classes
70+
#. :class:`beets.plugins.BeetsPlugin`
71+
is the base class for all plugins, any plugin needs to inherit from this class.
72+
#. :class:`beets.metadata_plugin.MetadataSourcePlugin`
73+
allows plugins to act like metadata sources. E.g. used by the MusicBrainz plugin. All plugins
74+
in the beets repo are opted into this class where applicable. If you are maintaining a plugin
75+
that acts like a metadata source, i.e. you expose any of `track_for_id,
76+
album_for_id, candidates, item_candidates, album_distance, track_distance` methods,
77+
please update your plugin to inherit from the new baseclass, as otherwise it will
78+
not be registered as a metadata source and wont be usable going forward.
79+
7080
Other changes:
7181

82+
* Refactor: Split responsibilities of Plugins into MetaDataPlugins and general Plugins.
7283
* Documentation structure for auto generated API references changed slightly.
7384
Autogenerated API references are now located in the `docs/api` subdirectory.
7485
* :doc:`/plugins/substitute`: Fix rST formatting for example cases so that each

0 commit comments

Comments
 (0)