summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-11-26 12:22:17 (GMT)
committerGitHub <noreply@github.com>2023-11-26 12:22:17 (GMT)
commitfc657d0c609eff0ca8ff7de22741be6ce11a9bd2 (patch)
tree2e64a6bafb19c073987b146fb6bf55fea0fed7e2
parent49005e4d02f49a1512577cb6c3eba2b68dbdd467 (diff)
downloadcpython-fc657d0c609eff0ca8ff7de22741be6ce11a9bd2.zip
cpython-fc657d0c609eff0ca8ff7de22741be6ce11a9bd2.tar.gz
cpython-fc657d0c609eff0ca8ff7de22741be6ce11a9bd2.tar.bz2
[3.11] gh-101100: Fix Sphinx reference warnings (GH-112416) (#112422)
-rw-r--r--Doc/c-api/set.rst2
-rw-r--r--Doc/extending/newtypes.rst4
-rw-r--r--Doc/library/asyncio-stream.rst4
-rw-r--r--Doc/library/email.errors.rst9
-rw-r--r--Doc/library/gzip.rst2
-rw-r--r--Doc/library/importlib.resources.rst4
-rw-r--r--Doc/library/xml.rst2
-rw-r--r--Doc/tools/.nitignore7
8 files changed, 20 insertions, 14 deletions
diff --git a/Doc/c-api/set.rst b/Doc/c-api/set.rst
index 09c0fb6..cba823a 100644
--- a/Doc/c-api/set.rst
+++ b/Doc/c-api/set.rst
@@ -147,7 +147,7 @@ subtypes but not for instances of :class:`frozenset` or its subtypes.
Return ``1`` if found and removed, ``0`` if not found (no action taken), and ``-1`` if an
error is encountered. Does not raise :exc:`KeyError` for missing keys. Raise a
- :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~set.discard`
+ :exc:`TypeError` if the *key* is unhashable. Unlike the Python :meth:`~frozenset.discard`
method, this function does not automatically convert unhashable sets into
temporary frozensets. Raise :exc:`SystemError` if *set* is not an
instance of :class:`set` or its subtype.
diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index 8ea76ae..dd561e6 100644
--- a/Doc/extending/newtypes.rst
+++ b/Doc/extending/newtypes.rst
@@ -321,7 +321,7 @@ An interesting advantage of using the :c:member:`~PyTypeObject.tp_members` table
descriptors that are used at runtime is that any attribute defined this way can
have an associated doc string simply by providing the text in the table. An
application can use the introspection API to retrieve the descriptor from the
-class object, and get the doc string using its :attr:`__doc__` attribute.
+class object, and get the doc string using its :attr:`!__doc__` attribute.
As with the :c:member:`~PyTypeObject.tp_methods` table, a sentinel entry with a :c:member:`~PyMethodDef.ml_name` value
of ``NULL`` is required.
@@ -473,7 +473,7 @@ instance of your data type. Here is a simple example::
return result;
}
-:c:type:`Py_hash_t` is a signed integer type with a platform-varying width.
+:c:type:`!Py_hash_t` is a signed integer type with a platform-varying width.
Returning ``-1`` from :c:member:`~PyTypeObject.tp_hash` indicates an error,
which is why you should be careful to avoid returning it when hash computation
is successful, as seen above.
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index e9d466d..4f7da27 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -204,6 +204,10 @@ StreamReader
directly; use :func:`open_connection` and :func:`start_server`
instead.
+ .. method:: feed_eof()
+
+ Acknowledge the EOF.
+
.. coroutinemethod:: read(n=-1)
Read up to *n* bytes from the stream.
diff --git a/Doc/library/email.errors.rst b/Doc/library/email.errors.rst
index 194a986..56aea65 100644
--- a/Doc/library/email.errors.rst
+++ b/Doc/library/email.errors.rst
@@ -58,6 +58,15 @@ The following exception classes are defined in the :mod:`email.errors` module:
:class:`~email.mime.nonmultipart.MIMENonMultipart` (e.g.
:class:`~email.mime.image.MIMEImage`).
+.. exception:: MessageDefect()
+
+ This is the base class for all defects found when parsing email messages.
+ It is derived from :exc:`ValueError`.
+
+.. exception:: HeaderDefect()
+
+ This is the base class for all defects found when parsing email headers.
+ It is derived from :exc:`MessageDefect`.
Here is the list of the defects that the :class:`~email.parser.FeedParser`
can find while parsing messages. Note that the defects are added to the message
diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst
index fdb5462..f95df41 100644
--- a/Doc/library/gzip.rst
+++ b/Doc/library/gzip.rst
@@ -105,7 +105,7 @@ The module defines the following items:
should only be provided in compression mode. If omitted or ``None``, the
current time is used. See the :attr:`mtime` attribute for more details.
- Calling a :class:`GzipFile` object's :meth:`close` method does not close
+ Calling a :class:`GzipFile` object's :meth:`!close` method does not close
*fileobj*, since you might wish to append more material after the compressed
data. This also allows you to pass an :class:`io.BytesIO` object opened for
writing as *fileobj*, and retrieve the resulting memory buffer using the
diff --git a/Doc/library/importlib.resources.rst b/Doc/library/importlib.resources.rst
index 437da69..d338ce07a 100644
--- a/Doc/library/importlib.resources.rst
+++ b/Doc/library/importlib.resources.rst
@@ -41,7 +41,7 @@ for example, a package and its resources can be imported from a zip file using
``get_resource_reader(fullname)`` method as specified by
:class:`importlib.resources.abc.ResourceReader`.
-.. data:: Package
+.. class:: Package
Whenever a function accepts a ``Package`` argument, you can pass in
either a :class:`module object <types.ModuleType>` or a module name
@@ -58,7 +58,7 @@ for example, a package and its resources can be imported from a zip file using
containers (think subdirectories).
*package* is either a name or a module object which conforms to the
- :data:`Package` requirements.
+ :class:`Package` requirements.
.. versionadded:: 3.9
diff --git a/Doc/library/xml.rst b/Doc/library/xml.rst
index 1e49b65..909022e 100644
--- a/Doc/library/xml.rst
+++ b/Doc/library/xml.rst
@@ -73,7 +73,7 @@ decompression bomb Safe Safe Safe
1. Expat 2.4.1 and newer is not vulnerable to the "billion laughs" and
"quadratic blowup" vulnerabilities. Items still listed as vulnerable due to
potential reliance on system-provided libraries. Check
- :const:`pyexpat.EXPAT_VERSION`.
+ :const:`!pyexpat.EXPAT_VERSION`.
2. :mod:`xml.etree.ElementTree` doesn't expand external entities and raises a
:exc:`~xml.etree.ElementTree.ParseError` when an entity occurs.
3. :mod:`xml.dom.minidom` doesn't expand external entities and simply returns
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index cb7558c..8ae1ab6 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -14,14 +14,12 @@ Doc/c-api/memory.rst
Doc/c-api/memoryview.rst
Doc/c-api/module.rst
Doc/c-api/object.rst
-Doc/c-api/set.rst
Doc/c-api/stable.rst
Doc/c-api/structures.rst
Doc/c-api/sys.rst
Doc/c-api/type.rst
Doc/c-api/typeobj.rst
Doc/extending/extending.rst
-Doc/extending/newtypes.rst
Doc/glossary.rst
Doc/howto/descriptor.rst
Doc/howto/enum.rst
@@ -33,7 +31,6 @@ Doc/library/abc.rst
Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.rst
-Doc/library/asyncio-stream.rst
Doc/library/asyncio-subprocess.rst
Doc/library/asyncio-task.rst
Doc/library/bdb.rst
@@ -55,7 +52,6 @@ Doc/library/dis.rst
Doc/library/email.charset.rst
Doc/library/email.compat32-message.rst
Doc/library/email.errors.rst
-Doc/library/email.headerregistry.rst
Doc/library/email.mime.rst
Doc/library/email.parser.rst
Doc/library/email.policy.rst
@@ -67,12 +63,10 @@ Doc/library/ftplib.rst
Doc/library/functions.rst
Doc/library/functools.rst
Doc/library/gettext.rst
-Doc/library/gzip.rst
Doc/library/http.client.rst
Doc/library/http.cookiejar.rst
Doc/library/http.cookies.rst
Doc/library/http.server.rst
-Doc/library/importlib.resources.rst
Doc/library/importlib.rst
Doc/library/inspect.rst
Doc/library/locale.rst
@@ -126,7 +120,6 @@ Doc/library/wsgiref.rst
Doc/library/xml.dom.minidom.rst
Doc/library/xml.dom.pulldom.rst
Doc/library/xml.dom.rst
-Doc/library/xml.rst
Doc/library/xml.sax.handler.rst
Doc/library/xml.sax.reader.rst
Doc/library/xml.sax.rst