Fix streaming docs

halcy · Apr 23, 2023 · 345e8c3 · 345e8c3
1 parent 137cf49
commit 345e8c3
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/mastodon/streaming_endpoints.py b/mastodon/streaming_endpoints.py
@@ -24,6 +24,9 @@ def stream_user(self, listener, run_async=False, timeout=_DEFAULT_STREAM_TIMEOUT
     def stream_public(self, listener, run_async=False, timeout=_DEFAULT_STREAM_TIMEOUT, reconnect_async=False, reconnect_async_wait_sec=_DEFAULT_STREAM_RECONNECT_WAIT_SEC, local=False, remote=False):
         """
         Streams public events.
+
+        Set `local` to True to only get local statuses.
+        Set `remote` to True to only get remote statuses.
         """
         base = '/api/v1/streaming/public'
         if local:
@@ -50,7 +53,7 @@ def stream_hashtag(self, tag, listener, local=False, run_async=False, timeout=_D
         Stream for all public statuses for the hashtag 'tag' seen by the connected
         instance.
 
-        Set local to True to only get local statuses.
+        Set `local` to True to only get local statuses.
         """
         if tag.startswith("#"):
             raise MastodonIllegalArgumentError("Tag parameter should omit leading #")