diff options
| author | Erik Johnston <erik@matrix.org> | 2019-10-30 11:52:04 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2019-10-30 11:52:04 +0000 |
| commit | 6e677403b7c71511374b1532b56e0c411840f87b (patch) | |
| tree | d7189d6d4efd037931254ad6855147190f1875a0 | |
| parent | Newsfile (diff) | |
| download | synapse-6e677403b7c71511374b1532b56e0c411840f87b.tar.xz | |
Clarify docstring
| -rw-r--r-- | synapse/util/async_helpers.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/synapse/util/async_helpers.py b/synapse/util/async_helpers.py index fd75ba27ad..b60a604474 100644 --- a/synapse/util/async_helpers.py +++ b/synapse/util/async_helpers.py @@ -88,6 +88,10 @@ class ObservableDeferred(object): def observe(self) -> defer.Deferred: """Observe the underlying deferred. + + This returns a brand new deferred that is resolved when the underlying + deferred is resolved. Interacting with the returned deferred does not + effect the underdlying deferred. """ if not self._result: d = defer.Deferred() |