Skip to content

bpo-33986: Fix typo and clarify in asyncio documentation #7981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kbumsik wants to merge 2 commits into from
Closed

bpo-33986: Fix typo and clarify in asyncio documentation #7981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
972a7ee
bpo-33986: Fix typo and clarify in asyncio documentation
kbumsik Jun 28, 2018
e0d764a
bpo-33986: Fix doc to reflect changes in 47cd10d7 (or Issue #23347)
kbumsik Jul 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions Doc/library/asyncio-protocol.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,10 @@ DatagramTransport
called with :const:`None` as its argument.


BaseSubprocessTransport
-----------------------
SubprocessTransport
-------------------

.. class:: BaseSubprocessTransport
.. class:: SubprocessTransport

.. method:: get_pid()

Expand Down Expand Up @@ -290,15 +290,14 @@ BaseSubprocessTransport
.. method:: terminate()

Ask the subprocess to stop, as in :meth:`subprocess.Popen.terminate`.
This method is an alias for the :meth:`close` method.

On POSIX systems, this method sends SIGTERM to the subprocess.
On Windows, the Windows API function TerminateProcess() is called to
stop the subprocess.

.. method:: close()

Ask the subprocess to stop by calling the :meth:`terminate` method if the
Ask the subprocess to stop by calling the :meth:`kill` method if the
subprocess hasn't returned yet, and close transports of all pipes
(*stdin*, *stdout* and *stderr*).

Expand Down
6 changes: 4 additions & 2 deletions Doc/library/asyncio-subprocess.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ Run subprocesses asynchronously using the :mod:`subprocess` module.
*shell*, which should not be specified at all.

Returns a pair of ``(transport, protocol)``, where *transport* is an
instance of :class:`BaseSubprocessTransport`.
instance of :class:`SubprocessTransport` and *protocol* is an object
instantiated by the *protocol_factory*.

This method is a :ref:`coroutine <coroutine>`.

Expand All @@ -132,7 +133,8 @@ Run subprocesses asynchronously using the :mod:`subprocess` module.
the remaining arguments.

Returns a pair of ``(transport, protocol)``, where *transport* is an
instance of :class:`BaseSubprocessTransport`.
instance of :class:`SubprocessTransport` and *protocol* is an object
instantiated by the *protocol_factory*.

It is the application's responsibility to ensure that all whitespace and
metacharacters are quoted appropriately to avoid `shell injection
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Documentation/2018-06-28-01-07-44.bpo-33986.19asdA.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fix wrong class name: asyncio.BaseSubprocessTransport -> SubprocessTransport,
and clarify return objects descriptions of AbstractEventLoop.subprocess_exec().
Fixed the description of SubprocessTransport.close().