summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichele Simionato <michele.simionato@gmail.com>2018-04-15 14:48:51 +0200
committerMichele Simionato <michele.simionato@gmail.com>2018-04-15 14:48:51 +0200
commit19a06ef38d8caf369a734909191b810fb7be972c (patch)
treedcba107f25279042acc9cdf537706a5aaba4bc28
parent3574ba07ef031dfd68dc8876e72c3ae17798c57a (diff)
downloadpython-decorator-git-19a06ef38d8caf369a734909191b810fb7be972c.tar.gz
Updated docs [skip CI]4.3.0
-rw-r--r--docs/tests.documentation.rst8
-rw-r--r--src/tests/documentation.py8
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/tests.documentation.rst b/docs/tests.documentation.rst
index f8af489..a0f34d8 100644
--- a/docs/tests.documentation.rst
+++ b/docs/tests.documentation.rst
@@ -573,7 +573,7 @@ that gives an idea of how you could manage permissions in a framework:
"Only the admin can delete objects"
-where `restricted` is a decorator factory defined as follows
+where ``restricted`` is a decorator factory defined as follows
.. code-block:: python
@@ -593,11 +593,11 @@ In general a decorator factory has a signature
.. code-block:: python
- def decfactory(func, param1=default1, .., paramN=defaultN, *args, **kw):
+ def decfactory(func, par1=default1, .., parN=defaultN, *a, **k):
...
-Each parameter must have a default, so that `decfactory` can work
-as an alias for `decfactory()`, i.e. the decorator in which are parameters
+Each parameter must have a default, so that ``decfactory`` can work
+as an alias for ``decfactory()``, i.e. the decorator in which all parameters
have the default value.
``decorator(cls)``
diff --git a/src/tests/documentation.py b/src/tests/documentation.py
index 2da44c6..b54a3f3 100644
--- a/src/tests/documentation.py
+++ b/src/tests/documentation.py
@@ -437,7 +437,7 @@ that gives an idea of how you could manage permissions in a framework:
$$Action
-where `restricted` is a decorator factory defined as follows
+where ``restricted`` is a decorator factory defined as follows
$$restricted
@@ -445,11 +445,11 @@ In general a decorator factory has a signature
.. code-block:: python
- def decfactory(func, param1=default1, .., paramN=defaultN, *args, **kw):
+ def decfactory(func, par1=default1, .., parN=defaultN, *a, **k):
...
-Each parameter must have a default, so that `decfactory` can work
-as an alias for `decfactory()`, i.e. the decorator in which are parameters
+Each parameter must have a default, so that ``decfactory`` can work
+as an alias for ``decfactory()``, i.e. the decorator in which all parameters
have the default value.
``decorator(cls)``