diff options
author | 2022-05-19 08:56:59 -0700 | |
---|---|---|
committer | 2022-05-19 17:56:59 +0200 | |
commit | 27302ae2df658c55ff0a20136b58b426e6d49a30 (patch) | |
tree | 937c1bd672b64c9be0d37322b71b614f1eb75c5d | |
parent | gh-92417: `subprocess` docs: remove note on compatibility with Python <3.5 (G... (diff) | |
download | cpython-27302ae2df658c55ff0a20136b58b426e6d49a30.tar.gz cpython-27302ae2df658c55ff0a20136b58b426e6d49a30.tar.bz2 cpython-27302ae2df658c55ff0a20136b58b426e6d49a30.zip |
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92974)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115)
Co-authored-by: Martin Fischer <martin@push-f.com>
-rw-r--r-- | Doc/library/asyncio-subprocess.rst | 4 | ||||
-rw-r--r-- | Doc/library/multiprocessing.rst | 1 | ||||
-rw-r--r-- | Doc/library/xml.etree.elementtree.rst | 2 |
3 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst index e5000532a89..28d0b21e818 100644 --- a/Doc/library/asyncio-subprocess.rst +++ b/Doc/library/asyncio-subprocess.rst @@ -124,6 +124,7 @@ Constants ========= .. data:: asyncio.subprocess.PIPE + :module: Can be passed to the *stdin*, *stdout* or *stderr* parameters. @@ -137,11 +138,13 @@ Constants attributes will point to :class:`StreamReader` instances. .. data:: asyncio.subprocess.STDOUT + :module: Special value that can be used as the *stderr* argument and indicates that standard error should be redirected into standard output. .. data:: asyncio.subprocess.DEVNULL + :module: Special value that can be used as the *stdin*, *stdout* or *stderr* argument to process creation functions. It indicates that the special file @@ -157,6 +160,7 @@ wrapper that allows communicating with subprocesses and watching for their completion. .. class:: asyncio.subprocess.Process + :module: An object that wraps OS processes created by the :func:`create_subprocess_exec` and :func:`create_subprocess_shell` diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 70802ee1fde..2a66b0f65c0 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -1666,6 +1666,7 @@ different machines. A manager object controls a server process which manages proxies. .. function:: multiprocessing.Manager() + :module: Returns a started :class:`~multiprocessing.managers.SyncManager` object which can be used for sharing objects between processes. The returned manager diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index e3932bc9e65..2fe0d2e082f 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -826,6 +826,7 @@ Functions ^^^^^^^^^ .. function:: xml.etree.ElementInclude.default_loader( href, parse, encoding=None) + :module: Default loader. This default loader reads an included resource from disk. *href* is a URL. *parse* is for parse mode either "xml" or "text". *encoding* @@ -837,6 +838,7 @@ Functions .. function:: xml.etree.ElementInclude.include( elem, loader=None, base_url=None, \ max_depth=6) + :module: This function expands XInclude directives. *elem* is the root element. *loader* is an optional resource loader. If omitted, it defaults to :func:`default_loader`. |