Explain why announcement rooms are kept apart from joined rooms

This commit is contained in:
Paul Chobert committed 2026-10-29 15:49:18 +01:00
1 parent b898610f01
commit 7ac3351e25
1 file changed
+3 -1
+3 -1
View File
@@ -3958,7 +3958,9 @@ class SyncResultBuilder:
now_token: The token to sync up to.
joined_room_ids: List of rooms the user is joined to
announcement_room_ids: Server announcement rooms the user is not a member
of, whose new announcements should still be sent to them.
of, whose new announcements should still be sent.
They are kept apart from `joined_room_ids` because most code that
reads `joined_room_ids` relies on the user being a member.
excluded_room_ids: Set of room ids we should omit from the /sync response.
forced_newly_joined_room_ids:
Rooms that should be presented in the /sync response as if they were