From fcc2de7a0c0c7a02b935c4b35394f228a5d5a304 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <richard@matrix.org>
Date: Fri, 3 Apr 2020 10:51:32 +0100
Subject: [PATCH] Update docstring per review comments

---
 synapse/storage/background_updates.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/synapse/storage/background_updates.py b/synapse/storage/background_updates.py
index 510963eb7f..59f3394b0a 100644
--- a/synapse/storage/background_updates.py
+++ b/synapse/storage/background_updates.py
@@ -179,7 +179,7 @@ class BackgroundUpdater(object):
             desired_duration_ms(float): How long we want to spend
                 updating.
         Returns:
-            True if there is no more work to do, otherwise False
+            True if we have finished running all the background updates, otherwise False
         """
 
         def get_background_updates_txn(txn):