diff options
| author | Erik Johnston <erik@matrix.org> | 2017-03-30 17:05:53 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2017-03-30 17:05:53 +0100 |
| commit | 5b5b171f3e9223351f72150ea73e1c9797144eae (patch) | |
| tree | 6a07ae646722e05ee87b109fd8d81a2baa88c14c /synapse/util/async.py | |
| parent | Revert log context change (diff) | |
| download | synapse-5b5b171f3e9223351f72150ea73e1c9797144eae.tar.xz | |
Docs
Diffstat (limited to 'synapse/util/async.py')
| -rw-r--r-- | synapse/util/async.py | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/synapse/util/async.py b/synapse/util/async.py index 8495de496a..1453faf0ef 100644 --- a/synapse/util/async.py +++ b/synapse/util/async.py @@ -89,6 +89,11 @@ class ObservableDeferred(object): deferred.addCallbacks(callback, errback) def observe(self): + """Observe the underlying deferred. + + Can return either a deferred if the underlying deferred is still pending + (or has failed), or the actual value. Callers may need to use maybeDeferred. + """ if not self._result: d = defer.Deferred() |