Skip to content

gh-101100: Fix sphinx warnings in library/asyncio-subprocess.rst #130994

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.

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

Merged
merged 1 commit into from
Mar 10, 2025
Merged
Changes from all commits
Commits
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
20 changes: 10 additions & 10 deletions Doc/library/asyncio-subprocess.rst
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ Creating Subprocesses
Create a subprocess.

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).

Return a :class:`~asyncio.subprocess.Process` instance.
@@ -87,7 +87,7 @@ Creating Subprocesses
Run the *cmd* shell command.

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).

Return a :class:`~asyncio.subprocess.Process` instance.
@@ -132,12 +132,12 @@ Constants

If *PIPE* is passed to *stdin* argument, the
: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
:attr:`Process.stdout <asyncio.subprocess.Process.stdout>` and
: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
:module:
@@ -165,7 +165,7 @@ their completion.
:module:

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.

This class is designed to have a similar API to the
@@ -263,24 +263,24 @@ their completion.

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.

On Windows this method is an alias for :meth:`terminate`.

.. 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``.

.. 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``.

.. 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``.

.. warning::
@@ -296,7 +296,7 @@ their completion.

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.

.. attribute:: returncode
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
@@ -14,7 +14,6 @@ Doc/c-api/typeobj.rst
Doc/extending/extending.rst
Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-subprocess.rst
Doc/library/decimal.rst
Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst