From: Ezio Melotti <ezio.melotti@gmail.com>
Date: Tue, 5 Aug 2014 05:14:28 +0000 (+0300)
Subject: #21928: clarify functools.wraps docs.
X-Git-Tag: v3.4.2rc1~149
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=67f6d5f4d0b166839818f7fbf447a1a2e9ae5b5a;p=thirdparty%2FPython%2Fcpython.git

#21928: clarify functools.wraps docs.
---

diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index c46b7997c1b4..96645c361c46 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):