deprecation notices

This commit is contained in:
Jesse Bannon 2023-07-24 11:06:08 -07:00
parent 10646fa1db
commit 36d99e9a82
4 changed files with 28 additions and 4 deletions

View file

@ -195,7 +195,7 @@ music_tags
'''''''''' ''''''''''
.. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions() .. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions()
:members: :members:
:exclude-members: partial_validate :exclude-members: partial_validate, embed_thumbnail
------------------------------------------------------------------------------- -------------------------------------------------------------------------------

View file

@ -0,0 +1,25 @@
Deprecation Notices
===================
July 2023
---------
embed_thumbnail
^^^^^^^^^^^^^^^
Embedding thumbnails has its own dedicated plugin now, which supports both audio and video files.
It will be removed from ``music_tags`` in October 2023. Convert from:
.. code-block:: yaml
my_example_preset:
music_tags:
embed_thumbnail: True
To the following:
.. code-block:: yaml
my_example_preset:
embed_thumbnail: True

View file

@ -26,3 +26,4 @@ Contents
getting_started getting_started
presets presets
config config
deprecation_notices

View file

@ -70,8 +70,6 @@ class MusicTagsOptions(OptionsDictValidator):
albumartists: albumartists:
- "{artist}" - "{artist}"
- "ytdl-sub" - "ytdl-sub"
# Optional
embed_thumbnail: False
""" """
_required_keys = {"tags"} _required_keys = {"tags"}
@ -151,7 +149,7 @@ class MusicTagsPlugin(Plugin[MusicTagsOptions]):
if self.plugin_options.embed_thumbnail: if self.plugin_options.embed_thumbnail:
logger.warning( logger.warning(
"music_tags.embed_thumbnail is now deprecated. Use the dedicated " "music_tags.embed_thumbnail is now deprecated. Use the dedicated "
"embed_thumbnail plugin instead" "embed_thumbnail plugin instead. This will be removed in October of 2023."
) )
# convert the entry thumbnail so it is embedded as jpg # convert the entry thumbnail so it is embedded as jpg