summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichele Simionato <michele.simionato@gmail.com>2018-04-15 14:44:35 +0200
committerMichele Simionato <michele.simionato@gmail.com>2018-04-15 14:44:35 +0200
commit6c7d67b033a17eaaa551adbc9cdc9ad098a2bc59 (patch)
tree4a96dc2f632346fbe554cf92e5f76374e78f8ad3 /docs
parent9e5235962d8d7e67f41a1ef7b7d70b1cc7e55d0b (diff)
downloadpython-decorator-git-6c7d67b033a17eaaa551adbc9cdc9ad098a2bc59.tar.gz
Updated docs [skip CI]
Diffstat (limited to 'docs')
-rw-r--r--docs/tests.documentation.rst35
1 files changed, 19 insertions, 16 deletions
diff --git a/docs/tests.documentation.rst b/docs/tests.documentation.rst
index c6d606c..e69cfa2 100644
--- a/docs/tests.documentation.rst
+++ b/docs/tests.documentation.rst
@@ -555,7 +555,25 @@ available. For instance:
some data
Decorator factories are most useful to framework builders. Here is an example
-that gives an idea of how you could manage permissions in a Web framework:
+that gives an idea of how you could manage permissions in a framework:
+
+.. code-block:: python
+
+ class Action(object):
+ @restricted(User)
+ def view(self):
+ "Any user can view objects"
+
+ @restricted(PowerUser)
+ def insert(self):
+ "Only power users can insert objects"
+
+ @restricted(Admin)
+ def delete(self):
+ "Only the admin can delete objects"
+
+
+where `restricted` is a decorator factory defined as follows
.. code-block:: python
@@ -570,21 +588,6 @@ that gives an idea of how you could manage permissions in a Web framework:
'%s does not have the permission to run %s!'
% (self.user, func.__name__))
-.. code-block:: python
-
- class Action(object):
- @restricted(User)
- def view(self):
- pass
-
- @restricted(PowerUser)
- def insert(self):
- pass
-
- @restricted(Admin)
- def delete(self):
- pass
-
``decorator(cls)``
--------------------------------------------