aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2017-12-11 15:30:24 +0100
committerLorenz Diener <[email protected]>2017-12-11 15:30:24 +0100
commitce5b0ca5768c926f73434f157b19cc185471f1af (patch)
treeae729c6dcbdb36f8f6d2b52cacd104a1f5380aac
parent8a8c62a8e787a3a56cff5ebc1cd25075d4cd7712 (diff)
downloadmastodon.py-ce5b0ca5768c926f73434f157b19cc185471f1af.tar.gz
Update docs, fixes #106
-rw-r--r--docs/index.rst3
-rw-r--r--mastodon/Mastodon.py6
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).
547 547
548If async is True, the listener will listen on another thread and these methods 548If async is True, the listener will listen on another thread and these methods
549will return a handle corresponding to the open connection. The 549will return a handle corresponding to the open connection. The
550connection may be closed at any time by calling its close() method. 550connection may be closed at any time by calling the handles close() method, and the
551status of the connection can be verified calling is_alive() on the handle.
551 552
552The streaming functions take instances of `StreamListener` as a parameter. 553The streaming functions take instances of `StreamListener` as a parameter.
553A `CallbackStreamListener` class that allows you to specify function callbacks 554A `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:
1177 @api_version("1.1.0") 1177 @api_version("1.1.0")
1178 def stream_hashtag(self, tag, listener, async=False): 1178 def stream_hashtag(self, tag, listener, async=False):
1179 """ 1179 """
1180 Returns all public statuses for the hashtag 'tag'. 'listener' should be 1180 Stream for all public statuses for the hashtag 'tag' seen by the connected
1181 a subclass of StreamListener which will receive callbacks for incoming 1181 instance. 'listener' should be a subclass of StreamListener which will receive
1182 events. 1182 callbacks for incoming events.
1183 """ 1183 """
1184 if tag.startswith("#"): 1184 if tag.startswith("#"):
1185 raise MastodonIllegalArgumentError("Tag parameter should omit leading #") 1185 raise MastodonIllegalArgumentError("Tag parameter should omit leading #")
Powered by cgit v1.2.3 (git 2.41.0)