From d84d47bd5069570789469a7c1ebd72c92f90d419 Mon Sep 17 00:00:00 2001 From: SeoulSKY Date: Mon, 2 Sep 2024 05:31:27 -0600 Subject: [PATCH] Update docs --- docs/changelog.rst | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 655e39e..013b783 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,24 +4,23 @@ Changelog v2.1.0 ------ -* From now on, YouTubeNotifier extends AsyncYouTubeNotifier and AsyncYouTubeNotifier extends object. BaseYouTubeNotifier was removed. -* Added (Async)YouTubeNotifier.run_in_background(). It works like the run method but immediately returns when the notifier is running. -* Added (Async) YouTubeNotifier.unsubscribe(). It unsubscribes the subscribed channel IDs -* From now on, (Async)YouTubeNotifier.subscribe() immediately raises ValueError when the given channel IDs are invalid. It didn't raise an error in the past until the notifier started running. +* From now on, ``YouTubeNotifier`` extends ``AsyncYouTubeNotifier`` and ``AsyncYouTubeNotifier`` extends ``object``. ``BaseYouTubeNotifier`` was removed. +* Added ``(Async)YouTubeNotifier.run_in_background()``. It works like the run method but immediately returns when the notifier is running. +* Added ``(Async) YouTubeNotifier.unsubscribe()``. It unsubscribes the subscribed channel IDs +* From now on, ``(Async)YouTubeNotifier.subscribe()`` immediately raises ``ValueError`` when the given channel IDs are invalid. It didn't raise an error in the past until the notifier started running. * Improved the speed of verifying channel IDs Deprecations -~~~~~~~~~ +~~~~~~~~~~~~ -The following methods are deprecated and will be removed in version 3.0.0 -* AsyncYouTubeNotifier.serve() -> use AsyncYouTubeNotifier.run() -* (Async)YouTubeNotifier.add_listener() -> use either add_any_listener(), add_upload_listener(), or add_edit_listener() +The following methods are deprecated and will be removed in version ``3.0.0`` +* ``AsyncYouTubeNotifier.serve()`` -> ``use AsyncYouTubeNotifier.run()`` +* ``(Async)YouTubeNotifier.add_listener()`` -> use either ``add_any_listener()``, ``add_upload_listener()``, or ``add_edit_listener()`` -The following decorators are deprecated and will be removed in version 3.0.0 -* @(Async)YouTubeNotifier.listener() -> use either @any, @upload or @edit +The following decorators are deprecated and will be removed in version ``3.0.0`` +* ``(Async)YouTubeNotifier.listener()`` -> use either ``any``, ``upload`` or ``edit`` **Full Changelog**: https://github.com/SeoulSKY/ytnoti/compare/v2.0.1...v2.1.0 - v2.0.1 ------