Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MadLittleMods merged 2 commits into from
Apr 10, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59ac92e
Fix `maybe_backfill(limit=...)` description
MadLittleMods Mar 30, 2026
5fab3ba
Add changelog
MadLittleMods Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/19630.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix docstring for `limit` argument in `_maybe_backfill_inner(...)`.
4 changes: 3 additions & 1 deletion synapse/handlers/federation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,9 @@ async def _maybe_backfill_inner(
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.
Comment on lines +245 to +247

@MadLittleMods MadLittleMods Mar 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_maybe_backfill_inner was updated to match maybe_backfill

synapse/synapse/handlers/federation.py

Lines 203 to 205 in f772fad

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.

You can see that the previous description was incorrect because we hard-code 100 events to backfill

synapse/synapse/handlers/federation.py

Lines 464 to 466 in f772fad

await self._federation_event_handler.backfill(
dom, room_id, limit=100, extremities=extremities_to_request
)

processing_start_time: The time when `maybe_backfill` started processing.
Only used for timing. If `None`, no timing observation will be made.

Expand Down
Loading