summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2021-12-16 15:51:27 -0600
committerEric Eastwood <erice@element.io>2021-12-16 15:51:27 -0600
commit3810ae10aa5ac60f4c99e8294ce40ccd6043b7cb (patch)
treef6772efd570d7521e2564c7d3eb7a2c8bd996a1c
parentPlumb allow_no_prev_events through create_and_send_nonmember_event (diff)
downloadsynapse-3810ae10aa5ac60f4c99e8294ce40ccd6043b7cb.tar.xz
Clarify comments
-rw-r--r--synapse/handlers/room_batch.py10
1 files changed, 6 insertions, 4 deletions
diff --git a/synapse/handlers/room_batch.py b/synapse/handlers/room_batch.py
index 5dcc28620f..f8137ec04c 100644
--- a/synapse/handlers/room_batch.py
+++ b/synapse/handlers/room_batch.py
@@ -178,8 +178,9 @@ class RoomBatchHandler:
         state_event_ids_at_start = []
         auth_event_ids = initial_auth_event_ids.copy()
 
-        # Make the state events float off on their own so we don't have a
-        # bunch of `@mxid joined the room` noise between each batch
+        # Make the state events float off on their own by specifying no
+        # prev_events for the first one in the chain so we don't have a bunch of
+        # `@mxid joined the room` noise between each batch.
         prev_event_ids_for_state_chain: List[str] = []
 
         for index, state_event in enumerate(state_events_at_start):
@@ -289,8 +290,9 @@ class RoomBatchHandler:
         """
         assert app_service_requester.app_service
 
-        # Make the historical event chain float off on its own which causes the
-        # HS to ask for the state at the start of the batch later.
+        # Make the historical event chain float off on its own by specifying no
+        # prev_events for the first event in the chain which causes the HS to
+        # ask for the state at the start of the batch later.
         prev_event_ids: List[str] = []
 
         event_ids = []