From ce5b0ca5768c926f73434f157b19cc185471f1af Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Mon, 11 Dec 2017 15:30:24 +0100 Subject: Update docs, fixes #106 --- docs/index.rst | 3 ++- mastodon/Mastodon.py | 6 +++--- 2 files changed, 5 insertions(+), 4 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). If async is True, the listener will listen on another thread and these methods will return a handle corresponding to the open connection. The -connection may be closed at any time by calling its close() method. +connection may be closed at any time by calling the handles close() method, and the +status of the connection can be verified calling is_alive() on the handle. The streaming functions take instances of `StreamListener` as a parameter. A `CallbackStreamListener` class that allows you to specify function callbacks diff --git a/mastodon/Mastodon.py b/mastodon/Mastodon.py index b52f13c..641b742 100644 --- a/mastodon/Mastodon.py +++ b/mastodon/Mastodon.py @@ -1177,9 +1177,9 @@ class Mastodon: @api_version("1.1.0") def stream_hashtag(self, tag, listener, async=False): """ - Returns all public statuses for the hashtag 'tag'. 'listener' should be - a subclass of StreamListener which will receive callbacks for incoming - events. + Stream for all public statuses for the hashtag 'tag' seen by the connected + instance. 'listener' should be a subclass of StreamListener which will receive + callbacks for incoming events. """ if tag.startswith("#"): raise MastodonIllegalArgumentError("Tag parameter should omit leading #") -- cgit v1.2.3