summary refs log tree commit diff
path: root/synapse/storage
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-07-12 16:59:59 +0100
committerErik Johnston <erik@matrix.org>2019-07-12 16:59:59 +0100
commitdb0a50bc40e4aca4a03fa3a09d33497f57f95c2d (patch)
tree0239cf361c8344f92444c7c4698a48ec5d9b2e62 /synapse/storage
parentpep8 (diff)
downloadsynapse-db0a50bc40e4aca4a03fa3a09d33497f57f95c2d.tar.xz
Fixup docstrings
Diffstat (limited to 'synapse/storage')
-rw-r--r--synapse/storage/stream.py12
1 files changed, 5 insertions, 7 deletions
diff --git a/synapse/storage/stream.py b/synapse/storage/stream.py
index f8e3007d67..a0465484df 100644
--- a/synapse/storage/stream.py
+++ b/synapse/storage/stream.py
@@ -835,7 +835,7 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
             as a list of _EventDictReturn and a token that points to the end
             of the result set. If no events are returned then the end of the
             stream has been reached (i.e. there are no events between
-            `from_token` and `to_token`).
+            `from_token` and `to_token`), or `limit` is zero.
         """
 
         assert int(limit) >= 0
@@ -912,12 +912,10 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
                 those that match the filter.
 
         Returns:
-            tuple[list[FrozenEvents], str]: Returns the results as a list of
-            dicts and a token that points to the end of the result set. The
-            dicts have the keys "event_id", "topological_ordering" and
-            "stream_ordering". If no events are returned then the end of the
-            stream has been reached (i.e. there are no events between
-            `from_key` and `to_key`).
+            tuple[list[FrozenEvent], str]: Returns the results as a list of
+            events and a token that points to the end of the result set. If no
+            events are returned then the end of the stream has been reached
+            (i.e. there are no events between `from_key` and `to_key`).
         """
 
         from_key = RoomStreamToken.parse(from_key)