diff options
| author | Lorenz Diener <[email protected]> | 2017-12-11 15:30:24 +0100 |
|---|---|---|
| committer | Lorenz Diener <[email protected]> | 2017-12-11 15:30:24 +0100 |
| commit | ce5b0ca5768c926f73434f157b19cc185471f1af (patch) | |
| tree | ae729c6dcbdb36f8f6d2b52cacd104a1f5380aac /docs | |
| parent | 8a8c62a8e787a3a56cff5ebc1cd25075d4cd7712 (diff) | |
| download | mastodon.py-ce5b0ca5768c926f73434f157b19cc185471f1af.tar.gz | |
Update docs, fixes #106
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 1813f2b..9c669d5 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
| @@ -547,7 +547,8 @@ exception is raised). | |||
| 547 | 547 | ||
| 548 | If async is True, the listener will listen on another thread and these methods | 548 | If async is True, the listener will listen on another thread and these methods |
| 549 | will return a handle corresponding to the open connection. The | 549 | will return a handle corresponding to the open connection. The |
| 550 | connection may be closed at any time by calling its close() method. | 550 | connection may be closed at any time by calling the handles close() method, and the |
| 551 | status of the connection can be verified calling is_alive() on the handle. | ||
| 551 | 552 | ||
| 552 | The streaming functions take instances of `StreamListener` as a parameter. | 553 | The streaming functions take instances of `StreamListener` as a parameter. |
| 553 | A `CallbackStreamListener` class that allows you to specify function callbacks | 554 | A `CallbackStreamListener` class that allows you to specify function callbacks |