summary refs log tree commit diff
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2023-10-06 07:25:44 -0400
committerGitHub <noreply@github.com>2023-10-06 07:25:44 -0400
commitae5b997cfac1a7d7540be7352f1c01295ce9100a (patch)
treee52a0d2228ecdee2028c64a42353fb481297ed35
parentAdd documentation on background updates. (#16420) (diff)
downloadsynapse-ae5b997cfac1a7d7540be7352f1c01295ce9100a.tar.xz
Fix comments related to replication. (#16428)
-rw-r--r--changelog.d/16428.misc1
-rw-r--r--synapse/federation/sender/__init__.py2
-rw-r--r--synapse/replication/tcp/commands.py2
3 files changed, 2 insertions, 3 deletions
diff --git a/changelog.d/16428.misc b/changelog.d/16428.misc
new file mode 100644
index 0000000000..75c9c3b757
--- /dev/null
+++ b/changelog.d/16428.misc
@@ -0,0 +1 @@
+Improve code comments.
diff --git a/synapse/federation/sender/__init__.py b/synapse/federation/sender/__init__.py
index fb20fd8a10..7b6b1da090 100644
--- a/synapse/federation/sender/__init__.py
+++ b/synapse/federation/sender/__init__.py
@@ -67,7 +67,7 @@ The loop continues so long as there is anything to send. At each iteration of th
 
 When the `PerDestinationQueue` has the catch-up flag set, the *Catch-Up Transmission Loop*
 (`_catch_up_transmission_loop`) is used in lieu of the regular `_transaction_transmission_loop`.
-(Only once the catch-up mode has been exited can the regular tranaction transmission behaviour
+(Only once the catch-up mode has been exited can the regular transaction transmission behaviour
 be resumed.)
 
 *Catch-Up Mode*, entered upon Synapse startup or once a homeserver has fallen behind due to
diff --git a/synapse/replication/tcp/commands.py b/synapse/replication/tcp/commands.py
index 1b92302fd3..0f0f851b79 100644
--- a/synapse/replication/tcp/commands.py
+++ b/synapse/replication/tcp/commands.py
@@ -446,8 +446,6 @@ class RemoteServerUpCommand(_SimpleCommand):
     """Sent when a worker has detected that a remote server is no longer
     "down" and retry timings should be reset.
 
-    If sent from a client the server will relay to all other workers.
-
     Format::
 
         REMOTE_SERVER_UP <server>