summaryrefslogtreecommitdiff
path: root/doc/using.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/using.rst')
-rw-r--r--doc/using.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/using.rst b/doc/using.rst
index 25687c6..8e62110 100644
--- a/doc/using.rst
+++ b/doc/using.rst
@@ -134,10 +134,12 @@ aiogreen specific functions:
.. function:: wrap_greenthread(gt)
- Wrap a greenthread into a Future object.
+ Wrap an eventlet GreenThread or a greenlet into a Future object.
The Future object waits for the completion of a greenthread.
+ The greenlet must not be running.
+
In debug mode, if the greenthread raises an exception, the exception is
logged to ``sys.stderr`` by eventlet, even if the exception is copied to the
Future object.