mirror of
https://github.com/element-hq/synapse.git
synced 2025-03-31 03:45:13 +00:00
Clarify docstring
This commit is contained in:
parent
1de28183cb
commit
6e677403b7
1 changed files with 4 additions and 0 deletions
|
@ -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()
|
||||
|
|
Loading…
Add table
Reference in a new issue