From 99e4a995b5b890b851c7a8052813fcf5ae499a45 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 3 Apr 2020 15:44:56 +0100
Subject: [PATCH] Fix up comments

---
 synapse/replication/tcp/client.py  |  2 +-
 synapse/replication/tcp/handler.py | 10 ++++++----
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/synapse/replication/tcp/client.py b/synapse/replication/tcp/client.py
index bf64901418..700ae79158 100644
--- a/synapse/replication/tcp/client.py
+++ b/synapse/replication/tcp/client.py
@@ -77,7 +77,7 @@ class ReplicationClientFactory(ReconnectingClientFactory):
 
 
 class ReplicationDataHandler:
-    """A replication data handler handles incoming stream updates from replication.
+    """Handles incoming stream updates from replication.
 
     This instance notifies the slave data store about updates. Can be subclassed
     to handle updates in additional ways.
diff --git a/synapse/replication/tcp/handler.py b/synapse/replication/tcp/handler.py
index 39d660b856..27493a53a9 100644
--- a/synapse/replication/tcp/handler.py
+++ b/synapse/replication/tcp/handler.py
@@ -45,7 +45,8 @@ inbound_rdata_count = Counter(
 
 
 class ReplicationCommandHandler:
-    """Handles incoming commands from replication.
+    """Handles incoming commands from replication as well as sending commands
+    back out to connections.
     """
 
     def __init__(self, hs):
@@ -92,8 +93,9 @@ class ReplicationCommandHandler:
             raise
 
         if cmd.token is None or stream_name not in self._streams_connected:
-            # I.e. this is part of a batch of updates for this stream. Batch
-            # until we get an update for the stream with a non None token
+            # I.e. either this is part of a batch of updates for this stream (in
+            # which case batch until we get an update for the stream with a non
+            # None token) or we're currently connecting so we queue up rows.
             self._pending_batches.setdefault(stream_name, []).append(row)
         else:
             # Check if this is the last of a batch of updates
@@ -126,7 +128,7 @@ class ReplicationCommandHandler:
         self._streams_connected.discard(cmd.stream_name)
         self._pending_batches.clear()
 
-        # We protect catching up with a linearizer in case the replicaiton
+        # We protect catching up with a linearizer in case the replication
         # connection reconnects under us.
         with await self._position_linearizer.queue(cmd.stream_name):
             # Find where we previously streamed up to.