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 5ed056f commit fc645eb
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ It's useful for development purposes.
What are the differences between YoutubeNotifier and AsyncYoutubeNotifier?
--------------------------------------------------------------------------

Their usage is very similar, except that the AsyncYouTubeNotifier has ``serve()`` method instead of ``run()`` method.
Following are the differences between them:
Their usage is very similar, except for the followings:

YouTubeNotifier
~~~~~~~~~~~~~~~
Expand All @@ -25,8 +24,8 @@ YouTubeNotifier
AsyncYouTubeNotifier
~~~~~~~~~~~~~~~~~~~~
* Public methods are asynchronous.
* ``serve()`` method can only be run in the main thread.
* Serves in the existing asyncio event loop.
* ``run()`` method can only be run in the main thread.
* Runs in the existing asyncio event loop.

To see the difference in usage between them,
see the `sync.py <https://github.com/SeoulSKY/ytnoti/tree/main/examples/basic/sync.py>`_ and
Expand Down

0 comments on commit fc645eb

Please sign in to comment.