diff options
author | Michele Simionato <michele.simionato@gmail.com> | 2018-04-15 14:44:55 +0200 |
---|---|---|
committer | Michele Simionato <michele.simionato@gmail.com> | 2018-04-15 14:44:55 +0200 |
commit | 3574ba07ef031dfd68dc8876e72c3ae17798c57a (patch) | |
tree | aa28e2f4f3de0b056c464c5a34a36a976269269d | |
parent | 6c7d67b033a17eaaa551adbc9cdc9ad098a2bc59 (diff) | |
download | python-decorator-git-3574ba07ef031dfd68dc8876e72c3ae17798c57a.tar.gz |
Updated docs [skip CI]
-rw-r--r-- | docs/tests.documentation.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/tests.documentation.rst b/docs/tests.documentation.rst index e69cfa2..f8af489 100644 --- a/docs/tests.documentation.rst +++ b/docs/tests.documentation.rst @@ -589,6 +589,17 @@ where `restricted` is a decorator factory defined as follows % (self.user, func.__name__)) +In general a decorator factory has a signature + +.. code-block:: python + + def decfactory(func, param1=default1, .., paramN=defaultN, *args, **kw): + ... + +Each parameter must have a default, so that `decfactory` can work +as an alias for `decfactory()`, i.e. the decorator in which are parameters +have the default value. + ``decorator(cls)`` -------------------------------------------- |