Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
erikjohnston committed May 9, 2018
1 parent 05e0a24 commit 75552d2
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions synapse/storage/stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ def get_recent_event_ids_for_room(self, room_id, limit, end_token):
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.
"""
Expand Down Expand Up @@ -514,7 +514,8 @@ def _set_before_and_after(events, rows, topo_order=True):
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
Expand Down Expand Up @@ -692,9 +693,9 @@ def _paginate_room_events_txn(self, txn, room_id, from_token, to_token=None,
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
Expand Down

0 comments on commit 75552d2

Please sign in to comment.