summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichele Simionato <michele.simionato@gmail.com>2017-07-15 12:35:40 +0200
committerMichele Simionato <michele.simionato@gmail.com>2017-07-15 12:35:40 +0200
commit37bc4776f49cc7f2b7060d393378ac6d5d68b10e (patch)
treebdb566e2116dc1c4a665a5e0278f4d98ef28c7de /docs
parentf068b08cf60cecea4b540d3a36550d0d29455b0e (diff)
downloadpython-decorator-git-37bc4776f49cc7f2b7060d393378ac6d5d68b10e.tar.gz
Removed the .pdf from the repo
Diffstat (limited to 'docs')
-rw-r--r--docs/README.rst4
-rw-r--r--docs/tests.documentation.rst11
2 files changed, 7 insertions, 8 deletions
diff --git a/docs/README.rst b/docs/README.rst
index d61c99e..4e6b827 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -18,7 +18,7 @@ If you are lazy, just perform
which will install just the module on your system.
If you prefer to install the full distribution from source, including
-the documentation, download the tarball_, unpack it and run
+the documentation, clone the [GitHub repo](https://github.com/micheles/decorator) or download the tarball_, unpack it and run
`$ pip install .`
@@ -30,7 +30,7 @@ in the main directory, possibly as superuser.
Testing
--------
-Run
+If you have the source code installtion you can run the tests with
`$ python src/tests/test.py -v`
diff --git a/docs/tests.documentation.rst b/docs/tests.documentation.rst
index 681ab36..1b817a0 100644
--- a/docs/tests.documentation.rst
+++ b/docs/tests.documentation.rst
@@ -1,12 +1,12 @@
\
The ``decorator`` module
-=============================================================
+------------------------
:Author: Michele Simionato
:E-mail: michele.simionato@gmail.com
-:Version: 4.1.0 (2017-07-15)
+:Version: 4.1.1 (2017-07-15)
:Supports: Python 2.6, 2.7, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6
-:Download page: http://pypi.python.org/pypi/decorator/4.1.0
+:Download page: http://pypi.python.org/pypi/decorator/4.1.1
:Installation: ``pip install decorator``
:License: BSD license
@@ -173,7 +173,7 @@ Here I used the functools.update_wrapper_ utility, which was added
in Python 2.5 to simplify the writing of decorators.
(Previously, you needed to manually copy the function attributes
``__name__``, ``__doc__``, ``__module__``, and ``__dict__``
-to the decorated function by hand.)
+to the decorated function by hand).
Here is an example of usage:
@@ -773,8 +773,7 @@ not what you want:
<BLANKLINE>
(See bug report 1764286_ for an explanation of what is happening).
-Unfortunately the bug still exists in all versions of Python, except
-Python 3.5.
+Unfortunately the bug still exists in all versions of Python < 3.5.
However, there is a workaround. The decorated function has the ``__wrapped__``
attribute, pointing to the original function. The simplest way to get the