summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-11-22 01:11:56 +0100
committerVictor Stinner <victor.stinner@gmail.com>2014-11-22 01:11:56 +0100
commit55d67bff867619b0f8bf261c85c9b24c49cf8528 (patch)
treea391232358fb9d036ae4eefe65b6a3ff010bb0a4
parentca6dfddf966414c7463c01b0deef0766b971857d (diff)
downloadaioeventlet-55d67bff867619b0f8bf261c85c9b24c49cf8528.tar.gz
doc
-rw-r--r--aiogreen.py10
-rw-r--r--doc/using.rst28
2 files changed, 20 insertions, 18 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()
diff --git a/doc/using.rst b/doc/using.rst
index 3f220a1..2db3979 100644
--- a/doc/using.rst
+++ b/doc/using.rst
@@ -85,15 +85,15 @@ API
aiogreen specific functions:
.. warning::
- aiogreen API is not stable yet. Function names may change in future
- releases, functions may change completly or even be removed.
+ aiogreen API is not considered as stable yet.
link_future
-----------
.. function:: link_future(future)
- Wait for a future (or a task) from a greenthread.
+ Wait for a future, or a task, from a greenthread.
+
Return the result or raise the exception of the future.
The function must not be called from the greenthread of the aiogreen event
@@ -101,8 +101,8 @@ link_future
.. versionchanged:: 0.3
- :func:`link_future` now raises an exception if it is called from the
- greenthread of the aiogreen event loop.
+ An exception is now raised if it is called from the greenthread of the
+ aiogreen event loop.
Example of greenthread waiting for a trollius task. The ``progress()``
callback is called regulary to see that the event loop in not blocked::
@@ -149,19 +149,19 @@ wrap_greenthread
.. function:: wrap_greenthread(gt)
- Wrap an eventlet GreenThread or a greenlet 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 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 or greenlet must be wrapped before its execution starts.
- If the greenthread or greenlet is running or already finished, an exception
- is raised.
+ The greenthread must be wrapped before its execution starts. If the
+ greenthread is running or already finished, an exception is raised.
.. versionchanged:: 0.3
- :func:`wrap_greenthread` now raises an exception if the greenthread is
- running or already finished. In debug mode, the exception is not more logged
- to sys.stderr for greenthreads.
+ An exception is now raised if the greenthread is running or already
+ finished. In debug mode, the exception is not more logged to sys.stderr
+ for greenthreads.
Example of trollius coroutine waiting for a greenthread. The ``progress()``
callback is called regulary to see that the event loop in not blocked::
@@ -255,7 +255,7 @@ Run tests
Run tests with tox
------------------
-The `tox project <https://testrun.org/tox/latest/>`_ can be used to build a
+The `tox project <http://testrun.org/tox/latest/>`_ can be used to build a
virtual environment with all runtime and test dependencies and run tests
against different Python versions (2.6, 2.7, 3.2, 3.3, 3.4).