mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-10-01 08:25:44 -04:00
Fixup docstrings
This commit is contained in:
parent
b4f5416dd9
commit
db0a50bc40
@ -835,7 +835,7 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
|
|||||||
as a list of _EventDictReturn and a token that points to the end
|
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
|
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
|
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
|
assert int(limit) >= 0
|
||||||
@ -912,12 +912,10 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
|
|||||||
those that match the filter.
|
those that match the filter.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
tuple[list[FrozenEvents], str]: Returns the results as a list of
|
tuple[list[FrozenEvent], str]: Returns the results as a list of
|
||||||
dicts and a token that points to the end of the result set. The
|
events and a token that points to the end of the result set. If no
|
||||||
dicts have the keys "event_id", "topological_ordering" and
|
events are returned then the end of the stream has been reached
|
||||||
"stream_ordering". If no events are returned then the end of the
|
(i.e. there are no events between `from_key` and `to_key`).
|
||||||
stream has been reached (i.e. there are no events between
|
|
||||||
`from_key` and `to_key`).
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from_key = RoomStreamToken.parse(from_key)
|
from_key = RoomStreamToken.parse(from_key)
|
||||||
|
Loading…
Reference in New Issue
Block a user