Improve docs

2020-05-21 16:58:10 +02:00 · 2020-05-21 16:58:10 +02:00 · d906ca6577
parent 70d17c53dc
commit d906ca6577
1 changed files with 2 additions and 1 deletions
--- a/synapse/storage/data_stores/main/devices.py
+++ b/synapse/storage/data_stores/main/devices.py
@ -653,7 +653,8 @@ class DeviceWorkerStore(SQLBaseStore):
        self, user_ids: Optional[Collection[str]] = None,
    ) -> Set[str]:
        """Given a list of remote users return the list of users that we
-        should resync the device lists for.
+        should resync the device lists for. If None is given instead of a list,
+        return every user that we should resync the device lists for.

        Returns:
            The IDs of users whose device lists need resync.