]> 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 cc7ef344120cb39057c944800b2eaf0bfb647bba..9336f799f785beea640c9c3eff158cce22d03b9f 100644 (file)
@@ -124,9 +124,10 @@ The :mod:`functools` module defines the following functions:
 
 .. function:: wraps(wrapped[, assigned][, updated])
 
-   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):