diff options
author | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2023-11-25 23:40:19 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-25 23:40:19 (GMT) |
commit | 3faf8e586d36e73faba13d9b61663afed6a24cb4 (patch) | |
tree | c766743b912d6d0b78794d6bea5729a5b8281e47 /Doc/extending | |
parent | 97f8f28b3e50196f6713faceccc2e15039117470 (diff) | |
download | cpython-3faf8e586d36e73faba13d9b61663afed6a24cb4.zip cpython-3faf8e586d36e73faba13d9b61663afed6a24cb4.tar.gz cpython-3faf8e586d36e73faba13d9b61663afed6a24cb4.tar.bz2 |
gh-101100: Fix Sphinx reference warnings (GH-112416)
* Fix Sphinx warning in library/xml.rst
Direct use of the pyexpat module is deprecated, but this is how to check the version for security purposes
* Fix Sphinx warning in library/importlib.resources.rst
* Use italics for parameters
* Link to the exception
* Fix Sphinx warning in library/gzip.rst
* Document message and header defect base classes to fix Sphinx warning in library/email.headerregistry.rst
* Restore feed_eof() doc to fix Sphinx warning in library/asyncio-stream.rst
* Fix Sphinx warning in extending/newtypes.rst
* Fix Sphinx warning in c-api/set.rst
On stdtypes.rst, set and frozenset are documented together and the frozenset has the working refs
Diffstat (limited to 'Doc/extending')
-rw-r--r-- | Doc/extending/newtypes.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst index 9f166eb..7a92b32 100644 --- a/Doc/extending/newtypes.rst +++ b/Doc/extending/newtypes.rst @@ -296,7 +296,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. |