aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 9083fc9..e555912 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1305,9 +1305,8 @@ A `CallbackStreamListener` class that allows you to specify function callbacks
1305directly is included for convenience. 1305directly is included for convenience.
1306 1306
1307For new well-known events implement the streaming function in `StreamListener` or `CallbackStreamListener`. 1307For new well-known events implement the streaming function in `StreamListener` or `CallbackStreamListener`.
1308The function name is `on_` + the event name. If the event-name contains dots, use an underscore instead. 1308The function name is `on_` + the event name. If the event name contains dots, they are replaced with
1309 1309underscored, e.g. for an event called 'status.update' the listener function should be named `on_status_update`.
1310E.g. for `'status.update'` the listener function should be named as `on_status_update`.
1311 1310
1312It may be that future Mastodon versions will come with completely new (unknown) event names. In this 1311It may be that future Mastodon versions will come with completely new (unknown) event names. In this
1313case a (deprecated) Mastodon.py would throw an error. If you want to avoid this in general, you can 1312case a (deprecated) Mastodon.py would throw an error. If you want to avoid this in general, you can
@@ -1336,6 +1335,7 @@ StreamListener
1336.. automethod:: StreamListener.on_notification 1335.. automethod:: StreamListener.on_notification
1337.. automethod:: StreamListener.on_delete 1336.. automethod:: StreamListener.on_delete
1338.. automethod:: StreamListener.on_conversation 1337.. automethod:: StreamListener.on_conversation
1338.. automethod:: StreamListener.on_status_update
1339.. automethod:: StreamListener.on_unknown_event 1339.. automethod:: StreamListener.on_unknown_event
1340.. automethod:: StreamListener.on_abort 1340.. automethod:: StreamListener.on_abort
1341.. automethod:: StreamListener.handle_heartbeat 1341.. automethod:: StreamListener.handle_heartbeat
Powered by cgit v1.2.3 (git 2.41.0)