From 5b5b171f3e9223351f72150ea73e1c9797144eae Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 30 Mar 2017 17:05:53 +0100
Subject: Docs

---
 synapse/util/async.py | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'synapse/util')

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()
 
-- 
cgit 1.4.1