Fix docstring for limit argument in _maybe_backfill_inner(...) (#19630)

Incorrectly labeled in https://github.com/matrix-org/synapse/pull/13535.

`maybe_backfill` already accurately describes `limit` (introduced in
https://github.com/matrix-org/synapse/pull/8349)

Spotted in
https://github.com/element-hq/synapse/pull/19611#discussion_r3011259710
This commit is contained in:
Eric Eastwood
2026-04-10 13:58:30 -05:00
committed by GitHub
parent 62523d89ba
commit 0e3e947bd6
2 changed files with 4 additions and 1 deletions

1
changelog.d/19630.misc Normal file
View File

@@ -0,0 +1 @@
Fix docstring for `limit` argument in `_maybe_backfill_inner(...)`.

View File

@@ -242,7 +242,9 @@ class FederationHandler:
Args:
room_id: The room to backfill in.
current_depth: The depth to check at for any upcoming backfill points.
limit: The max number of events to request from the remote federated server.
limit: The number of events that the pagination request will
return. This is used as part of the heuristic to decide if we
should back paginate.
processing_start_time: The time when `maybe_backfill` started processing.
Only used for timing. If `None`, no timing observation will be made.