summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2014-03-13 09:58:03 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2014-03-13 09:58:03 (GMT)
commit2fb3b8270604caa459011c607c7af0c68b2adf28 (patch)
treed42c13bded84b6c92434968973ccad5139fae670 /Doc/library
parent39930c9ca0e8ad2e1465e7a31b4a400d6f34ccff (diff)
downloadcpython-2fb3b8270604caa459011c607c7af0c68b2adf28.zip
cpython-2fb3b8270604caa459011c607c7af0c68b2adf28.tar.gz
cpython-2fb3b8270604caa459011c607c7af0c68b2adf28.tar.bz2
asyncio doc: functions are coroutine, they don't return a coroutine
It's not exact, but easier to understand.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/asyncio-protocol.rst2
-rw-r--r--Doc/library/asyncio-subprocess.rst4
-rw-r--r--Doc/library/asyncio-sync.rst2
3 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
index cbbc151..80c974a 100644
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -497,6 +497,6 @@ TCP echo server example, send back received data and close the connection::
: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
index f1f7bd9..861bcc0 100644
--- a/Doc/library/asyncio-subprocess.rst
+++ b/Doc/library/asyncio-subprocess.rst
@@ -11,13 +11,13 @@ Create a subprocess
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
index ceed5df..a299f09 100644
--- a/Doc/library/asyncio-sync.rst
+++ b/Doc/library/asyncio-sync.rst
@@ -73,7 +73,7 @@ Lock
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()