diff options
author | Mark Haines <mjark@negativecurvature.net> | 2016-04-01 16:20:09 +0100 |
---|---|---|
committer | Mark Haines <mjark@negativecurvature.net> | 2016-04-01 16:20:09 +0100 |
commit | 89e6839a487fdcf048b11481137c0c73ffa4f167 (patch) | |
tree | 6e45dccf9d58a596952457b73890178af973a6f0 /synapse/notifier.py | |
parent | Merge pull request #684 from matrix-org/markjh/backfill_id_gen (diff) | |
parent | Use google style doc strings. (diff) | |
download | synapse-89e6839a487fdcf048b11481137c0c73ffa4f167.tar.xz |
Merge pull request #686 from matrix-org/markjh/doc_strings
Use google style doc strings.
Diffstat (limited to 'synapse/notifier.py')
-rw-r--r-- | synapse/notifier.py | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/synapse/notifier.py b/synapse/notifier.py index f00cd8c588..6af7a8f424 100644 --- a/synapse/notifier.py +++ b/synapse/notifier.py @@ -503,13 +503,14 @@ class Notifier(object): def wait_for_replication(self, callback, timeout): """Wait for an event to happen. - :param callback: - Gets called whenever an event happens. If this returns a truthy - value then ``wait_for_replication`` returns, otherwise it waits - for another event. - :param int timeout: - How many milliseconds to wait for callback return a truthy value. - :returns: + Args: + callback: Gets called whenever an event happens. If this returns a + truthy value then ``wait_for_replication`` returns, otherwise + it waits for another event. + timeout: How many milliseconds to wait for callback return a truthy + value. + + Returns: A deferred that resolves with the value returned by the callback. """ listener = _NotificationListener(None) |