summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--synapse/util/async_helpers.py4
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()