Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SeoulSKY committed Sep 2, 2024
1 parent 8571ef0 commit d84d47b
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------

Expand Down

0 comments on commit d84d47b

Please sign in to comment.