summaryrefslogtreecommitdiff
path: root/Doc/library/functools.rst
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2014-08-05 08:14:28 +0300
committerEzio Melotti <ezio.melotti@gmail.com>2014-08-05 08:14:28 +0300
commit88172c0b92b2f55112c8b6ad8340c2650966b4ad (patch)
treec3d4344a750afcc27589ca73b175c516179131f2 /Doc/library/functools.rst
parent489e6be72d7f1be72a81993ef10255888c291f58 (diff)
downloadcpython-88172c0b92b2f55112c8b6ad8340c2650966b4ad.tar.gz
#21928: clarify functools.wraps docs.
Diffstat (limited to 'Doc/library/functools.rst')
-rw-r--r--Doc/library/functools.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index c46b7997c1..96645c361c 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -413,9 +413,10 @@ The :mod:`functools` module defines the following functions:
.. decorator:: wraps(wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)
- This is a convenience function for invoking ``partial(update_wrapper,
- wrapped=wrapped, assigned=assigned, updated=updated)`` as a function decorator
- when defining a wrapper function. For example:
+ This is a convenience function for invoking :func:`update_wrapper` as a
+ function decorator when defining a wrapper function. It is equivalent to
+ ``partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)``.
+ For example::
>>> from functools import wraps
>>> def my_decorator(f):