From cfcc6bccc77c4747d304ec173c93f4f9839b9012 Mon Sep 17 00:00:00 2001 From: halcy Date: Tue, 15 Nov 2022 10:44:34 +0200 Subject: Prep 1.6.0 --- docs/conf.py | 4 ++-- docs/index.rst | 17 ++++++++++------- 2 files changed, 12 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index ac8858f..306563e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,9 +66,9 @@ author = u'Lorenz Diener' # built documents. # # The short X.Y version. -version = u'1.5' +version = u'1.6' # The full version, including alpha/beta/rc tags. -release = u'1.5.2' +release = u'1.6.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index 025896d..7fc59d2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1307,13 +1307,16 @@ For new well-known events implement the streaming function in `StreamListener` o The function name is `on_` + the event name. If the event name contains dots, they are replaced with underscored, e.g. for an event called 'status.update' the listener function should be named `on_status_update`. -It may be that future Mastodon versions will come with completely new (unknown) event names. In this -case a (deprecated) Mastodon.py would throw an error. If you want to avoid this in general, you can -override the listener function `on_unknown_event`. This has an additional parameter `name` which informs -about the name of the event. `unknown_event` contains the content of the event. - -Alternatively, a callback function can be passed in the `unknown_event_handler` parameter in the -`CallbackStreamListener` constructor. +It may be that future Mastodon versions will come with completely new (unknown) event names. +If you want to do something when such an event is received, override the listener function `on_unknown_event`. +This has an additional parameter `name` which informs about the name of the event. `unknown_event` contains the +content of the event. Alternatively, a callback function can be passed in the `unknown_event_handler` parameter +in the `CallbackStreamListener` constructor. + +Note that the `unknown_event` handler is *not* guaranteed to receive events once they have been implemented. +Events will only go to this handler temporarily, while Mastodon.py has not been updated. Changes to what events +do and do not go into the handler will not be considered a breaking change. If you want to handle a new event whose +name you _do_ know, define an appropriate handler in your StreamListener, which will work even if it is not listed here. When in not-async mode or async mode without async_reconnect, the stream functions may raise various exceptions: `MastodonMalformedEventError` if a received event cannot be parsed and -- cgit v1.2.3