From 7fafa838ae17429df150a27308a1f12becb60fb0 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Wed, 25 Apr 2018 11:59:22 +0100
Subject: [PATCH] Comment why the looping call loops

---
 synapse/handlers/profile.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 8332771c1..7699152cd 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -53,6 +53,9 @@ class ProfileHandler(BaseHandler):
             if len(self.hs.config.replicate_user_profiles_to) > 0:
                 reactor.callWhenRunning(self._assign_profile_replication_batches)
                 reactor.callWhenRunning(self._replicate_profiles)
+                # Add a looping call to replicate_profiles: this handles retries
+                # if the replication is unsuccessful when the user updated their
+                # profile.
                 self.clock.looping_call(
                     self._replicate_profiles, self.PROFILE_REPLICATE_INTERVAL
                 )