Review comments

bebeo92 · Sep 25, 2019 · 39b50ad · 39b50ad
1 parent f8b02c5
commit 39b50ad
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 7 deletions.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
@@ -315,7 +315,7 @@ redaction_retention_period: 7d
 
 # How long to track users' last seen time and IPs in the database.
 #
-# Defaults to `28d`. Set to `null` to disable.
+# Defaults to `28d`. Set to `null` to disable clearing out of old rows.
 #
 #user_ips_max_age: 14d
 

diff --git a/synapse/config/server.py b/synapse/config/server.py
@@ -745,7 +745,7 @@ def generate_config_section(
 
         # How long to track users' last seen time and IPs in the database.
         #
-        # Defaults to `28d`. Set to `null` to disable.
+        # Defaults to `28d`. Set to `null` to disable clearing out of old rows.
         #
         #user_ips_max_age: 14d
         """

diff --git a/synapse/storage/background_updates.py b/synapse/storage/background_updates.py
@@ -148,11 +148,8 @@ def has_completed_background_updates(self):
 
         return False
 
-    async def has_completed_background_update(self, update_name):
+    async def has_completed_background_update(self, update_name) -> bool:
         """Check if the given background update has finished running.
-
-        Returns:
-            Deferred[bool]
         """
 
         if self._all_done:

diff --git a/synapse/storage/client_ips.py b/synapse/storage/client_ips.py
@@ -506,7 +506,7 @@ async def _prune_old_user_ips(self):
         """Removes entries in user IPs older than the configured period.
         """
 
-        if not self.user_ips_max_age:
+        if self.user_ips_max_age is None:
             # Nothing to do
             return