FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Fix sphinx warnings in `library/asyncio-subprocess.rst` · Pull Request #130994 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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.

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

Merged
kumaraditya303 merged 1 commit into from Mar 10, 2025
Conversation 11 Commits 1 Checks 0 Files changed
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) dotfile  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
20 changes: 10 additions & 10 deletions Doc/library/asyncio-subprocess.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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::
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Back | FazBrowse Home | New Git URL