]> granicus.if.org Git - python/commitdiff
#21928: clarify functools.wraps docs.
authorEzio Melotti <ezio.melotti@gmail.com>
Tue, 5 Aug 2014 05:14:28 +0000 (08:14 +0300)
committerEzio Melotti <ezio.melotti@gmail.com>
Tue, 5 Aug 2014 05:14:28 +0000 (08:14 +0300)
Doc/library/functools.rst

index c46b7997c1b41c654cb24d5b9deda32813d248ab..96645c361c46807b3f786520faf4798d74349aaf 100644 (file)
@@ -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):