Update docs, fixes #106

This commit is contained in:
Lorenz Diener 2017-12-11 15:30:24 +01:00
pare 8a8c62a8e7
commit ce5b0ca576
S'han modificat 2 arxius amb 5 adicions i 4 eliminacions

Veure arxiu

@ -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

Veure arxiu

@ -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 #")