Skip to content

Commit a38af20

Browse files
turt2liverichvdh
andauthored
Apply suggestions from code review
Co-Authored-By: Richard van der Hoff <[email protected]>
1 parent e4339fd commit a38af20

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

api/client-server/message_pagination.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,14 @@ paths:
115115
type: array
116116
description: |-
117117
A list of state events relevant to showing the ``chunk``. For example, if
118-
lazy-loading members is enabled in the filter then this will contain any
119-
applicable membership events. Servers should be careful to not exclude
118+
``lazy_load_members`` is enabled in the filter then this will contain any
119+
the membership events for the the senders of events in the ``chunk``. Servers should be careful to not exclude
120120
membership events which are older than ones already sent to the client.
121121
Likewise, clients should be cautious and avoid using older membership
122122
events as the current membership event when paginating backwards.
123123
124124
Unless ``include_redundant_members`` is ``true``, the server should remove
125-
redundant members which would have already been sent to clients in prior calls
125+
membership events which would have already been sent to clients in prior calls
126126
to lazy-loading aware endpoints with the same filter.
127127
items:
128128
type: object

api/client-server/sync.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ paths:
4141
syncing user's own membership event when they join a room, or when the
4242
full state of rooms is requested. The user's own membership event is eligible
4343
for being considered redundant by the server. When a sync is ``limited``,
44-
the server MUST return membership events for events in the gap (from ``since``),
45-
even if the applicable events are not in the response, regardless as to whether
44+
the server MUST return membership events for events in the gap (between ``since`` and the start of the returned timeline),
45+
regardless as to whether
4646
or not they are redundant. ``include_redundant_members`` is ignored for limited
4747
syncs.
4848
operationId: sync

specification/client_server_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1286,7 +1286,7 @@ for the ``sender`` of events in the timeline, not all members of a room.
12861286
Repeated calls to lazy-loading aware endpoints will result in redundant membership
12871287
events being excluded by default. Clients often track which membership events they
12881288
already have, therefore making the extra information not as useful to the client.
1289-
Clients can always request redundant members by setting ``include_redundant_members``
1289+
Clients can always request redundant membership events by setting ``include_redundant_members``
12901290
to true in the filter.
12911291

12921292
Servers should be cautious about which events they consider redundant. Membership
@@ -1296,9 +1296,9 @@ as the current membership event for a user.
12961296

12971297
.. Note::
12981298
Repeated calls using the same filter to *any* lazy-loading aware endpoint may
1299-
result in redundant members being excluded from future calls. For example, a
1299+
result in redundant membership events being excluded from future calls. For example, a
13001300
request to ``/sync`` followed by a request to ``/messages`` may result in a
1301-
future call to ``/sync`` excluding members included by the ``/messages`` call.
1301+
future call to ``/sync`` excluding membership events returned by the ``/messages`` call.
13021302

13031303
The current endpoints which support lazy-loading room members are:
13041304

0 commit comments

Comments
 (0)