[Python-checkins] bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92976)
ambv
webhook-mailer at python.org
Thu May 19 12:04:03 EDT 2022
https://github.com/python/cpython/commit/a43f4e7487e5546bc798580c4754a93bbdf79712
commit: a43f4e7487e5546bc798580c4754a93bbdf79712
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2022-05-19T18:03:55+02:00
summary:
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92976)
(cherry picked from commit 2cdd57f119e3b85f1bfd28c7ff040e0d9bcaf115)
Co-authored-by: Łukasz Langa <lukasz at langa.pl>
Co-authored-by: Martin Fischer <martin at push-f.com>
files:
M Doc/library/asyncio-subprocess.rst
M Doc/library/multiprocessing.rst
M Doc/library/xml.etree.elementtree.rst
diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst
index fbe68f78a2f9b..4f8b0b3e68dd4 100644
--- a/Doc/library/asyncio-subprocess.rst
+++ b/Doc/library/asyncio-subprocess.rst
@@ -127,6 +127,7 @@ Constants
=========
.. data:: asyncio.subprocess.PIPE
+ :module:
Can be passed to the *stdin*, *stdout* or *stderr* parameters.
@@ -140,11 +141,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
@@ -160,6 +163,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 b62e1f8dba1bf..1bde2ec28ca0a 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -1648,6 +1648,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 92248e751632b..0d96a78cbbfd5 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -808,6 +808,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*
@@ -819,6 +820,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`.
More information about the Python-checkins
mailing list