From 6e677403b7c71511374b1532b56e0c411840f87b Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 30 Oct 2019 11:52:04 +0000
Subject: [PATCH] Clarify docstring
---
synapse/util/async_helpers.py | 4 ++++
1 file changed, 4 insertions(+)
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()
--
GitLab