[Python-checkins] cpython: asyncio doc: functions are coroutine, they don't return a coroutine

Thu Mar 13 10:58:12 CET 2014

http://hg.python.org/cpython/rev/077dce5c4196
changeset: 89625:077dce5c4196
user: Victor Stinner <victor.stinner at gmail.com>
date: Thu Mar 13 10:58:03 2014 +0100
summary:
 asyncio doc: functions are coroutine, they don't return a coroutine
It's not exact, but easier to understand.
files:
 Doc/library/asyncio-protocol.rst | 2 +-
 Doc/library/asyncio-subprocess.rst | 4 ++--
 Doc/library/asyncio-sync.rst | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -497,6 +497,6 @@
 :meth:`Transport.close` can be called immediately after
 :meth:`WriteTransport.write` even if data are not sent yet on the socket: both
 methods are asynchronous. ``yield from`` is not needed because these transport
-methods don't return coroutines.
+methods are not coroutines.
 
 
diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst
--- a/Doc/library/asyncio-subprocess.rst
+++ b/Doc/library/asyncio-subprocess.rst
@@ -11,13 +11,13 @@
 Run the shell command *cmd* given as a string. Return a :class:`~asyncio.subprocess.Process`
 instance.
 
- This function returns a :ref:`coroutine object <coroutine>`.
+ This function is a :ref:`coroutine <coroutine>`.
 
 .. function:: create_subprocess_exec(\*args, stdin=None, stdout=None, stderr=None, loop=None, limit=None, \*\*kwds)
 
 Create a subprocess. Return a :class:`~asyncio.subprocess.Process` instance.
 
- This function returns a :ref:`coroutine object <coroutine>`.
+ This function is a :ref:`coroutine <coroutine>`.
 
 Use the :meth:`BaseEventLoop.connect_read_pipe` and
 :meth:`BaseEventLoop.connect_write_pipe` methods to connect pipes.
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
--- a/Doc/library/asyncio-sync.rst
+++ b/Doc/library/asyncio-sync.rst
@@ -73,7 +73,7 @@
 This method blocks until the lock is unlocked, then sets it to locked and
 returns ``True``.
 
- This method returns a :ref:`coroutine object <coroutine>`.
+ This method is a :ref:`coroutine <coroutine>`.
 
 .. method:: release()
 
-- 
Repository URL: http://hg.python.org/cpython
