From 36d99e9a82582b8707a0d6eecc6beee8a7cc94eb Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Mon, 24 Jul 2023 11:06:08 -0700 Subject: [PATCH] deprecation notices --- docs/config.rst | 2 +- docs/deprecation_notices.rst | 25 +++++++++++++++++++++++++ docs/index.rst | 1 + src/ytdl_sub/plugins/music_tags.py | 4 +--- 4 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 docs/deprecation_notices.rst diff --git a/docs/config.rst b/docs/config.rst index 9b7458a8..adb05693 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -195,7 +195,7 @@ music_tags '''''''''' .. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions() :members: - :exclude-members: partial_validate + :exclude-members: partial_validate, embed_thumbnail ------------------------------------------------------------------------------- diff --git a/docs/deprecation_notices.rst b/docs/deprecation_notices.rst new file mode 100644 index 00000000..2a05181c --- /dev/null +++ b/docs/deprecation_notices.rst @@ -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 + diff --git a/docs/index.rst b/docs/index.rst index 7974add8..1ef6df9f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,3 +26,4 @@ Contents getting_started presets config + deprecation_notices diff --git a/src/ytdl_sub/plugins/music_tags.py b/src/ytdl_sub/plugins/music_tags.py index 722128ba..4f671d26 100644 --- a/src/ytdl_sub/plugins/music_tags.py +++ b/src/ytdl_sub/plugins/music_tags.py @@ -70,8 +70,6 @@ class MusicTagsOptions(OptionsDictValidator): albumartists: - "{artist}" - "ytdl-sub" - # Optional - embed_thumbnail: False """ _required_keys = {"tags"} @@ -151,7 +149,7 @@ class MusicTagsPlugin(Plugin[MusicTagsOptions]): if self.plugin_options.embed_thumbnail: logger.warning( "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