summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYuki Kobayashi <drsuaimqjgar@gmail.com>2025-03-10 12:38:08 (GMT)
committerGitHub <noreply@github.com>2025-03-10 12:38:08 (GMT)
commit7cc99a54b755cc7cc0b3680fde7834cf612d4fbc (patch)
tree5a233783c5754ebb70307251d9bfcf2b33236c81
parent98fa4a49fecbac3c990a25ce5d300592dad31be0 (diff)
downloadcpython-7cc99a54b755cc7cc0b3680fde7834cf612d4fbc.zip
cpython-7cc99a54b755cc7cc0b3680fde7834cf612d4fbc.tar.gz
cpython-7cc99a54b755cc7cc0b3680fde7834cf612d4fbc.tar.bz2
gh-101100: Fix sphinx warnings in `library/asyncio-subprocess.rst` (#130994)
-rw-r--r--Doc/library/asyncio-subprocess.rst20
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 10 insertions, 11 deletions
diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst
index 3e543a4..03e76bc 100644
--- a/Doc/library/asyncio-subprocess.rst
+++ b/Doc/library/asyncio-subprocess.rst
@@ -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
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index a158d44..f43dba1 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -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