diff options
| author | Erik Johnston <erik@matrix.org> | 2018-05-09 15:15:38 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2018-05-09 15:15:38 +0100 |
| commit | 75552d2148f9f48add495cb7b18a378b0abf70b9 (patch) | |
| tree | 69fe8dcdd4066666cb42a385a6c0f2a00acbff80 | |
| parent | Refactor pagination DB API to return concrete type (diff) | |
| download | synapse-75552d2148f9f48add495cb7b18a378b0abf70b9.tar.xz | |
Update comments
| -rw-r--r-- | synapse/storage/stream.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/synapse/storage/stream.py b/synapse/storage/stream.py index 772d2c6198..60d2dca154 100644 --- a/synapse/storage/stream.py +++ b/synapse/storage/stream.py @@ -385,7 +385,7 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore): Returns: Deferred[tuple[list[_EventDictReturn], str]]: Returns a list of - _EventDictReturn and a token pointint to the start of the returned + _EventDictReturn and a token pointing to the start of the returned events. The events returned are in ascending order. """ @@ -514,7 +514,8 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore): events (list[FrozenEvent]) rows (list[_EventDictReturn]) topo_order (bool): Whether the events were ordered topologically - or by stream ordering + or by stream ordering. If true then all rows should have a non + null topological_ordering. """ for event, row in zip(events, rows): stream = row.stream_ordering @@ -692,9 +693,9 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore): those that match the filter. Returns: - tuple[list[_EventDictReturn], str]: Returns the results as a list - of _EventDictReturn and a token that points to the end of the - result set. + Deferred[tuple[list[_EventDictReturn], str]]: Returns the results + as a list of _EventDictReturn and a token that points to the end + of the result set. """ # Tokens really represent positions between elements, but we use # the convention of pointing to the event before the gap. Hence |