2 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/17507.misc b/changelog.d/17507.misc
new file mode 100644
index 0000000000..82c4d263be
--- /dev/null
+++ b/changelog.d/17507.misc
@@ -0,0 +1 @@
+Update the `limited` field description in the Sliding Sync response to accurately describe what it actually represents.
diff --git a/synapse/types/handlers/__init__.py b/synapse/types/handlers/__init__.py
index 2f7e92665c..a6adf6c9ea 100644
--- a/synapse/types/handlers/__init__.py
+++ b/synapse/types/handlers/__init__.py
@@ -182,8 +182,8 @@ class SlidingSyncResult:
absent on joined/left rooms
prev_batch: A token that can be passed as a start parameter to the
`/rooms/<room_id>/messages` API to retrieve earlier messages.
- limited: True if their are more events than fit between the given position and now.
- Sync again to get more.
+ limited: True if there are more events than `timeline_limit` looking
+ backwards from the `response.pos` to the `request.pos`.
num_live: The number of timeline events which have just occurred and are not historical.
The last N events are 'live' and should be treated as such. This is mostly
useful to determine whether a given @mention event should make a noise or not.
|