aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2018-04-17 16:15:54 +0200
committerLorenz Diener <[email protected]>2018-04-17 16:15:54 +0200
commitb01edc49ee8831bb91d8e79eac5be8b8fb97af44 (patch)
treea7cc31428f7c2c263cde29742cd4781a10a1b2a9 /docs
parent864c83fa2fe7e09125a24f4a12acb4b1e285bc02 (diff)
downloadmastodon.py-b01edc49ee8831bb91d8e79eac5be8b8fb97af44.tar.gz
Improve docs again
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 4de0f6e..eebe893 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -731,7 +731,8 @@ If `async` is True, the listener will listen on another thread and these methods
731will return a handle corresponding to the open connection. If, in addition, `async_reconnect` is True, 731will return a handle corresponding to the open connection. If, in addition, `async_reconnect` is True,
732the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting 732the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting
733`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made 733`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made
734to "catch up" - toots made while the connection is broken will not be received. 734to "catch up" - events created while the connection is broken will not be received. If you need to make
735sure to get absolutely all notifications / deletes / toots, you will have to do that manually.
735 736
736The connection may be closed at any time by calling the handles close() method. The 737The connection may be closed at any time by calling the handles close() method. The
737current status of the handler thread can be checked with the handles is_alive() function, 738current status of the handler thread can be checked with the handles is_alive() function,
Powered by cgit v1.2.3 (git 2.41.0)