Sliding Sync: Fix limited response description (make accurate) (#17507)

Author: MadLittleMods

changelog.d/17507.misc

@@ -0,0 +1 @@
+Update the `limited` field description in the Sliding Sync response to accurately describe what it actually represents.

synapse/types/handlers/__init__.py

@@ -182,8 +182,8 @@ class RoomResult:
                 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.