From 37bc4687f765f9f3621e2ba992bacb775895dca5 Mon Sep 17 00:00:00 2001 From: Yuki Kobayashi Date: Thu, 20 Feb 2025 05:43:21 +0000 Subject: [PATCH] gh-101100: Fix sphinx warnings in `library/asyncio-subprocess.rst` --- Doc/library/asyncio-subprocess.rst | 20 ++++++++++---------- Doc/tools/.nitignore | 1 - 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst index 3e543a45e6525f..03e76bc868905e 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 ` 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 ` and :attr:`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 a158d447d4732e..f43dba19d1340c 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