Fix comments related to replication. (#16428)

This commit is contained in:
Patrick Cloke 2023-10-06 07:25:44 -04:00 committed by GitHub
parent 694802eecd
commit ae5b997cfa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 2 additions and 3 deletions

1
changelog.d/16428.misc Normal file
View File

@ -0,0 +1 @@
Improve code comments.

View File

@ -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* 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`. (`_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.) be resumed.)
*Catch-Up Mode*, entered upon Synapse startup or once a homeserver has fallen behind due to *Catch-Up Mode*, entered upon Synapse startup or once a homeserver has fallen behind due to

View File

@ -446,8 +446,6 @@ class RemoteServerUpCommand(_SimpleCommand):
"""Sent when a worker has detected that a remote server is no longer """Sent when a worker has detected that a remote server is no longer
"down" and retry timings should be reset. "down" and retry timings should be reset.
If sent from a client the server will relay to all other workers.
Format:: Format::
REMOTE_SERVER_UP <server> REMOTE_SERVER_UP <server>