openstack/deb-python-wrapt
Code Issues Proposed changes

Fix various typos/errors in documentation.

Browse Source
This commit is contained in:
Graham Dumpleton
2013-09-05 22:47:11 +10:00
parent b8e5c646a3
commit a6e6caec1b
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/decorators.rst
View File

@@ -80,7 +80,7 @@ use of keyword arguments when the decorator is used.
Processing Function Arguments Processing Function Arguments
----------------------------- -----------------------------
The original set of positionl arguments and keyword arguments supplied when The original set of positional arguments and keyword arguments supplied when
the decorated function is called will be passed in the ``args`` and the decorated function is called will be passed in the ``args`` and
``kwargs`` arguments. ``kwargs`` arguments.
@@ -217,7 +217,7 @@ Just the documentation string itself can still be obtained by accessing the
Wrapped Function Source Code Wrapped Function Source Code
---------------------------- ----------------------------
To obtain the argument specification of a decorated function the standard To obtain the source code of a decorated function the standard
``getsource()`` function from the ``inspect`` module can be used. ``getsource()`` function from the ``inspect`` module can be used.
:: ::
@@ -381,13 +381,13 @@ instance is already bound to ``wrapped`` and will be passed automatically
as the first argument to the original wrapped function. as the first argument to the original wrapped function.
Note that due to a bug in Python ``classmethod.__get__()``, whereby it does Note that due to a bug in Python ``classmethod.__get__()``, whereby it does
not apply the descriptor protocol to the function wrapped by ``classmethod``, not apply the descriptor protocol to the function wrapped by ``@classmethod``,
the above only applies where the decorator wraps the ``@classmethod`` the above only applies where the decorator wraps the ``@classmethod``
decorator. If the decorator is placed inside of the ``@classmethod`` decorator. If the decorator is placed inside of the ``@classmethod``
decorator, then ``instance`` will be ``None`` and the decorator wrapper decorator, then ``instance`` will be ``None`` and the decorator wrapper
function will see the call as being the same as a normal function. As a function will see the call as being the same as a normal function. As a
result, always place any decorator outside of the ``@classmethod`` result, always place any decorator outside of the ``@classmethod``
decorator. decorator. Hopefully this issue in Python can be addressed in Python 3.4.
Decorating Static Methods Decorating Static Methods
------------------------- -------------------------
@@ -437,7 +437,7 @@ Universal Decorators
A universal decorator is one that can be applied to different types of A universal decorator is one that can be applied to different types of
functions and can adjust automatically based on what is being decorated. functions and can adjust automatically based on what is being decorated.
For exapmple, the decorator may be able to be used on both a normal For example, the decorator may be able to be used on both a normal
function and an instance method, thereby avoiding the need to create two function and an instance method, thereby avoiding the need to create two
separate decorators to be used in each case. separate decorators to be used in each case.