aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 162d06c..63a8594 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,7 +37,7 @@ Mastodon.py
37 ) 37 )
38 mastodon.toot('Tooting from python using #mastodonpy !') 38 mastodon.toot('Tooting from python using #mastodonpy !')
39 39
40`Mastodon`_ is an ostatus based twitter-like federated social 40`Mastodon`_ is an ActivityPub and OStatus based twitter-like federated social
41network node. It has an API that allows you to interact with its 41network node. It has an API that allows you to interact with its
42every aspect. This is a simple python wrapper for that api, provided 42every aspect. This is a simple python wrapper for that api, provided
43as a single python module. By default, it talks to the 43as a single python module. By default, it talks to the
@@ -531,11 +531,18 @@ Streaming
531--------- 531---------
532These functions allow access to the streaming API. 532These functions allow access to the streaming API.
533 533
534If async is False, these methods block forever (or until an
535exception is raised).
536
537If async is True, the listener will listen on another thread and these methods
538will return a handle corresponding to the open connection. The
539connection may be closed at any time by calling its close() method.
540
534.. automethod:: Mastodon.user_stream 541.. automethod:: Mastodon.user_stream
535.. automethod:: Mastodon.public_stream 542.. automethod:: Mastodon.public_stream
543.. automethod:: Mastodon.local_stream
536.. automethod:: Mastodon.hashtag_stream 544.. automethod:: Mastodon.hashtag_stream
537 545
538
539.. _Mastodon: https://github.com/tootsuite/mastodon 546.. _Mastodon: https://github.com/tootsuite/mastodon
540.. _Mastodon flagship instance: http://mastodon.social/ 547.. _Mastodon flagship instance: http://mastodon.social/
541.. _Mastodon api docs: https://github.com/tootsuite/documentation/ 548.. _Mastodon api docs: https://github.com/tootsuite/documentation/
Powered by cgit v1.2.3 (git 2.41.0)