mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-09-07 09:21:51 +00:00
Assume key existence. Update docstrings
This commit is contained in:
parent
c061d4f237
commit
9ccea16d45
@ -209,9 +209,7 @@ class AdminHandler(BaseHandler):
|
||||
# Now check if this event is an unseen prev event, if so
|
||||
# then we remove this event from the appropriate dicts.
|
||||
for child_id in unseen_to_child_events.pop(event.event_id, []):
|
||||
event_to_unseen_prevs.get(child_id, set()).discard(
|
||||
event.event_id
|
||||
)
|
||||
event_to_unseen_prevs[child_id].discard(event.event_id)
|
||||
|
||||
written_events.add(event.event_id)
|
||||
|
||||
|
@ -833,7 +833,9 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
|
||||
Returns:
|
||||
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.
|
||||
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`).
|
||||
"""
|
||||
|
||||
assert int(limit) >= 0
|
||||
@ -905,15 +907,17 @@ class StreamWorkerStore(EventsWorkerStore, SQLBaseStore):
|
||||
only those before
|
||||
direction(char): Either 'b' or 'f' to indicate whether we are
|
||||
paginating forwards or backwards from `from_key`.
|
||||
limit (int): The maximum number of events to return. Zero or less
|
||||
means no limit.
|
||||
limit (int): The maximum number of events to return.
|
||||
event_filter (Filter|None): If provided filters the events to
|
||||
those that match the filter.
|
||||
|
||||
Returns:
|
||||
tuple[list[dict], 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_orderign".
|
||||
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`).
|
||||
"""
|
||||
|
||||
from_key = RoomStreamToken.parse(from_key)
|
||||
|
Loading…
Reference in New Issue
Block a user