summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-11-22 00:46:38 +0100
committerVictor Stinner <victor.stinner@gmail.com>2014-11-22 00:46:38 +0100
commitca6dfddf966414c7463c01b0deef0766b971857d (patch)
tree6b235d54fe404ba1a541f002cdabf6a50def478a
parent475df0102a4f99700aa7729c8c9feeb3116db72f (diff)
downloadaioeventlet-ca6dfddf966414c7463c01b0deef0766b971857d.tar.gz
add versionchanged to the API doc
-rw-r--r--doc/using.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/using.rst b/doc/using.rst
index be1edb2..3f220a1 100644
--- a/doc/using.rst
+++ b/doc/using.rst
@@ -88,6 +88,9 @@ aiogreen specific functions:
aiogreen API is not stable yet. Function names may change in future
releases, functions may change completly or even be removed.
+link_future
+-----------
+
.. function:: link_future(future)
Wait for a future (or a task) from a greenthread.
@@ -96,6 +99,11 @@ aiogreen specific functions:
The function must not be called from the greenthread of the aiogreen event
loop.
+ .. versionchanged:: 0.3
+
+ :func:`link_future` now raises an exception 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::
@@ -136,6 +144,9 @@ aiogreen specific functions:
computation in progress...
1 + 2 = 3
+wrap_greenthread
+----------------
+
.. function:: wrap_greenthread(gt)
Wrap an eventlet GreenThread or a greenlet into a Future object.
@@ -146,6 +157,12 @@ aiogreen specific functions:
If the greenthread or greenlet 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.
+
Example of trollius coroutine waiting for a greenthread. The ``progress()``
callback is called regulary to see that the event loop in not blocked::