Skip to content

gh-101100: Fix sphinx warnings in Doc/library/functools.rst #136424

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
merged 11 commits into from
Jul 11, 2025
+21 −13
Merged

gh-101100: Fix sphinx warnings in Doc/library/functools.rst #136424

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0f0ffc8
Update functools.rst
LamentXU123 Jul 8, 2025
8c11b08
Update .nitignore
LamentXU123 Jul 8, 2025
f74a61c
add index entries and anchors for cache_info, cache_clear and register
LamentXU123 Jul 8, 2025
06e1364
Update functools.rst
LamentXU123 Jul 10, 2025
a07190e
Apply suggestions from code review
LamentXU123 Jul 11, 2025
8864e6d
Update functools.rst
LamentXU123 Jul 11, 2025
f65d178
Apply suggestions from code review
LamentXU123 Jul 11, 2025
f82b0c4
Update functools.rst
LamentXU123 Jul 11, 2025
1edf2c4
Update functools.rst
LamentXU123 Jul 11, 2025
3265c93
Update functools.rst
LamentXU123 Jul 11, 2025
e420443
Merge branch 'main' into fix-referrence-in-functools
serhiy-storchaka Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Doc/library/functools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ The :mod:`functools` module defines the following functions:

.. decorator:: singledispatch

.. method:: register()
.. method:: singledispatch.register()
:no-typesetting:

Transform a function into a :term:`single-dispatch <single
Expand All @@ -508,7 +508,7 @@ The :mod:`functools` module defines the following functions:
... print("Let me just say,", end=" ")
... print(arg)

To add overloaded implementations to the function, use the :func:`register`
To add overloaded implementations to the function, use the :func:`!register`
attribute of the generic function, which can be used as a decorator. For
functions annotated with types, the decorator will infer the type of the
first argument automatically::
Expand Down Expand Up @@ -574,14 +574,14 @@ The :mod:`functools` module defines the following functions:
runtime impact.

To enable registering :term:`lambdas<lambda>` and pre-existing functions,
the :func:`register` attribute can also be used in a functional form::
the :func:`!register` attribute can also be used in a functional form::

>>> def nothing(arg, verbose=False):
... print("Nothing.")
...
>>> fun.register(type(None), nothing)

The :func:`register` attribute returns the undecorated function. This
The :func:`!register` attribute returns the undecorated function. This
enables decorator stacking, :mod:`pickling<pickle>`, and the creation
of unit tests for each variant independently::

Expand Down Expand Up @@ -659,10 +659,10 @@ The :mod:`functools` module defines the following functions:
.. versionadded:: 3.4

.. versionchanged:: 3.7
The :func:`register` attribute now supports using type annotations.
The :func:`!register` attribute now supports using type annotations.

.. versionchanged:: 3.11
The :func:`register` attribute now supports
The :func:`!register` attribute now supports
:class:`typing.Union` as a type annotation.


Expand Down