[Python-checkins] bpo-34748: link to :ref:`partial-objects` in functools.partial doc. (GH-9809)
Miss Islington (bot)
webhook-mailer at python.org
Tue Oct 23 02:16:54 EDT 2018
https://github.com/python/cpython/commit/42892a2a38bb97c41e7b1b154e2b5b6f13d27b57
commit: 42892a2a38bb97c41e7b1b154e2b5b6f13d27b57
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-10-22T23:16:51-07:00
summary:
bpo-34748: link to :ref:`partial-objects` in functools.partial doc. (GH-9809)
(cherry picked from commit 83a07652e0033f0d9994ae7634b91d6581c56b00)
Co-authored-by: Andrei Petre <p31andrei at gmail.com>
files:
M Doc/library/functools.rst
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 28062c11890e..b221a8584a12 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -167,10 +167,11 @@ The :mod:`functools` module defines the following functions:
.. function:: partial(func, *args, **keywords)
- Return a new :class:`partial` object which when called will behave like *func*
- called with the positional arguments *args* and keyword arguments *keywords*. If
- more arguments are supplied to the call, they are appended to *args*. If
- additional keyword arguments are supplied, they extend and override *keywords*.
+ Return a new :ref:`partial object<partial-objects>` which when called
+ will behave like *func* called with the positional arguments *args*
+ and keyword arguments *keywords*. If more arguments are supplied to the
+ call, they are appended to *args*. If additional keyword arguments are
+ supplied, they extend and override *keywords*.
Roughly equivalent to::
def partial(func, *args, **keywords):
@@ -209,7 +210,7 @@ The :mod:`functools` module defines the following functions:
:func:`classmethod`, :func:`staticmethod`, :func:`abstractmethod` or
another instance of :class:`partialmethod`), calls to ``__get__`` are
delegated to the underlying descriptor, and an appropriate
- :class:`partial` object returned as the result.
+ :ref:`partial object<partial-objects>` returned as the result.
When *func* is a non-descriptor callable, an appropriate bound method is
created dynamically. This behaves like a normal Python function when
More information about the Python-checkins
mailing list