From 39b50ad42a8cf784e627959e9652589338121ccd Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 25 Sep 2019 17:22:33 +0100
Subject: [PATCH] Review comments

---
 docs/sample_config.yaml               | 2 +-
 synapse/config/server.py              | 2 +-
 synapse/storage/background_updates.py | 5 +----
 synapse/storage/client_ips.py         | 2 +-
 4 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index cc6035c83..7902d9ed6 100644
--- 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
index 655e7487a..f8b7b4bef 100644
--- a/synapse/config/server.py
+++ b/synapse/config/server.py
@@ -745,7 +745,7 @@ class ServerConfig(Config):
 
         # 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
index 3fc25cd82..30788137a 100644
--- a/synapse/storage/background_updates.py
+++ b/synapse/storage/background_updates.py
@@ -148,11 +148,8 @@ class BackgroundUpdateStore(SQLBaseStore):
 
         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
index 176c812b1..a4d40dfa1 100644
--- a/synapse/storage/client_ips.py
+++ b/synapse/storage/client_ips.py
@@ -506,7 +506,7 @@ class ClientIpStore(background_updates.BackgroundUpdateStore):
         """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