[3.13] gh-101100: Fix sphinx warnings in `library/asyncio-subprocess.rst` (GH-130994) (#131074)

(cherry picked from commit 7cc99a54b7)
This commit is contained in:
Yuki Kobayashi 2025-03-11 21:30:47 +09:00 committed by GitHub
parent f9d19a3ada
commit a49f85a694
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 11 deletions

View File

@ -68,7 +68,7 @@ Creating Subprocesses
Create a subprocess. Create a subprocess.
The *limit* argument sets the buffer limit for :class:`StreamReader` The *limit* argument sets the buffer limit for :class:`StreamReader`
wrappers for :attr:`Process.stdout` and :attr:`Process.stderr` wrappers for :attr:`~asyncio.subprocess.Process.stdout` and :attr:`~asyncio.subprocess.Process.stderr`
(if :const:`subprocess.PIPE` is passed to *stdout* and *stderr* arguments). (if :const:`subprocess.PIPE` is passed to *stdout* and *stderr* arguments).
Return a :class:`~asyncio.subprocess.Process` instance. Return a :class:`~asyncio.subprocess.Process` instance.
@ -87,7 +87,7 @@ Creating Subprocesses
Run the *cmd* shell command. Run the *cmd* shell command.
The *limit* argument sets the buffer limit for :class:`StreamReader` The *limit* argument sets the buffer limit for :class:`StreamReader`
wrappers for :attr:`Process.stdout` and :attr:`Process.stderr` wrappers for :attr:`~asyncio.subprocess.Process.stdout` and :attr:`~asyncio.subprocess.Process.stderr`
(if :const:`subprocess.PIPE` is passed to *stdout* and *stderr* arguments). (if :const:`subprocess.PIPE` is passed to *stdout* and *stderr* arguments).
Return a :class:`~asyncio.subprocess.Process` instance. Return a :class:`~asyncio.subprocess.Process` instance.
@ -132,12 +132,12 @@ Constants
If *PIPE* is passed to *stdin* argument, the If *PIPE* is passed to *stdin* argument, the
:attr:`Process.stdin <asyncio.subprocess.Process.stdin>` attribute :attr:`Process.stdin <asyncio.subprocess.Process.stdin>` attribute
will point to a :class:`StreamWriter` instance. will point to a :class:`~asyncio.StreamWriter` instance.
If *PIPE* is passed to *stdout* or *stderr* arguments, the If *PIPE* is passed to *stdout* or *stderr* arguments, the
:attr:`Process.stdout <asyncio.subprocess.Process.stdout>` and :attr:`Process.stdout <asyncio.subprocess.Process.stdout>` and
:attr:`Process.stderr <asyncio.subprocess.Process.stderr>` :attr:`Process.stderr <asyncio.subprocess.Process.stderr>`
attributes will point to :class:`StreamReader` instances. attributes will point to :class:`~asyncio.StreamReader` instances.
.. data:: asyncio.subprocess.STDOUT .. data:: asyncio.subprocess.STDOUT
:module: :module:
@ -165,7 +165,7 @@ their completion.
:module: :module:
An object that wraps OS processes created by the An object that wraps OS processes created by the
:func:`create_subprocess_exec` and :func:`create_subprocess_shell` :func:`~asyncio.create_subprocess_exec` and :func:`~asyncio.create_subprocess_shell`
functions. functions.
This class is designed to have a similar API to the This class is designed to have a similar API to the
@ -263,24 +263,24 @@ their completion.
Kill the child process. Kill the child process.
On POSIX systems this method sends :py:data:`SIGKILL` to the child On POSIX systems this method sends :py:data:`~signal.SIGKILL` to the child
process. process.
On Windows this method is an alias for :meth:`terminate`. On Windows this method is an alias for :meth:`terminate`.
.. attribute:: stdin .. attribute:: stdin
Standard input stream (:class:`StreamWriter`) or ``None`` Standard input stream (:class:`~asyncio.StreamWriter`) or ``None``
if the process was created with ``stdin=None``. if the process was created with ``stdin=None``.
.. attribute:: stdout .. attribute:: stdout
Standard output stream (:class:`StreamReader`) or ``None`` Standard output stream (:class:`~asyncio.StreamReader`) or ``None``
if the process was created with ``stdout=None``. if the process was created with ``stdout=None``.
.. attribute:: stderr .. attribute:: stderr
Standard error stream (:class:`StreamReader`) or ``None`` Standard error stream (:class:`~asyncio.StreamReader`) or ``None``
if the process was created with ``stderr=None``. if the process was created with ``stderr=None``.
.. warning:: .. warning::
@ -296,7 +296,7 @@ their completion.
Process identification number (PID). Process identification number (PID).
Note that for processes created by the :func:`create_subprocess_shell` Note that for processes created by the :func:`~asyncio.create_subprocess_shell`
function, this attribute is the PID of the spawned shell. function, this attribute is the PID of the spawned shell.
.. attribute:: returncode .. attribute:: returncode

View File

@ -15,7 +15,6 @@ Doc/extending/extending.rst
Doc/library/ast.rst Doc/library/ast.rst
Doc/library/asyncio-extending.rst Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.rst Doc/library/asyncio-policy.rst
Doc/library/asyncio-subprocess.rst
Doc/library/decimal.rst Doc/library/decimal.rst
Doc/library/email.charset.rst Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst Doc/library/email.compat32-message.rst