Skip to content

Commit 0e3e947

Browse files
Fix docstring for limit argument in _maybe_backfill_inner(...) (#19630)
Incorrectly labeled in matrix-org/synapse#13535. `maybe_backfill` already accurately describes `limit` (introduced in matrix-org/synapse#8349) Spotted in #19611 (comment)
1 parent 62523d8 commit 0e3e947

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

changelog.d/19630.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix docstring for `limit` argument in `_maybe_backfill_inner(...)`.

synapse/handlers/federation.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,9 @@ async def _maybe_backfill_inner(
242242
Args:
243243
room_id: The room to backfill in.
244244
current_depth: The depth to check at for any upcoming backfill points.
245-
limit: The max number of events to request from the remote federated server.
245+
limit: The number of events that the pagination request will
246+
return. This is used as part of the heuristic to decide if we
247+
should back paginate.
246248
processing_start_time: The time when `maybe_backfill` started processing.
247249
Only used for timing. If `None`, no timing observation will be made.
248250

0 commit comments

Comments
 (0)