summaryrefslogtreecommitdiff
path: root/aiogreen.py
diff options
context:
space:
mode:
Diffstat (limited to 'aiogreen.py')
-rw-r--r--aiogreen.py10
1 files changed, 6 insertions, 4 deletions
diff --git a/aiogreen.py b/aiogreen.py
index 1a7fdde..341e67d 100644
--- a/aiogreen.py
+++ b/aiogreen.py
@@ -255,11 +255,13 @@ class EventLoopPolicy(asyncio.DefaultEventLoopPolicy):
def wrap_greenthread(gt, loop=None):
- """Wrap an eventlet GreenThread or a greenlet into a Future object.
+ """Wrap an eventlet GreenThread, or a greenlet, into a Future object.
- The greenthread or greenlet must be wrapped before its execution starts.
- If the greenthread or greenlet is running or already finished, an exception
- is raised.
+ The Future object waits for the completion of a greenthread. The result
+ or the exception of the greenthread will be stored in the Future object.
+
+ The greenthread must be wrapped before its execution starts. If the
+ greenthread is running or already finished, an exception is raised.
"""
if loop is None:
loop = asyncio.get_event_loop()