summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2017-06-14 23:21:04 -0500
committerMichael Merickel <michael@merickel.org>2017-06-14 23:21:04 -0500
commit21300198ee62eb00b757a77f2792329ff2d882a0 (patch)
tree5da780eaaa91dec2210b4ff9203fad345c3bcba5 /docs/api
parent2e015c97443d381832554161d090b7608dba1e16 (diff)
downloadpyramid-21300198ee62eb00b757a77f2792329ff2d882a0.tar.gz
pyramid-21300198ee62eb00b757a77f2792329ff2d882a0.tar.bz2
pyramid-21300198ee62eb00b757a77f2792329ff2d882a0.zip
fix p.security.ACLPermitsResult to subclass p.security.PermitsResult
The ``IAuthorizationPolicy`` is expected to return an instance of ``PermitsResult`` and the ``ACLPermitsResult`` now subclasses this to form a consistent class hierarchy. Similarly the ``ACLDenied`` subclasses ``Denied`` and ``ACLAllowed`` subclasses ``Allowed`` for consistency.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/security.rst22
1 files changed, 15 insertions, 7 deletions
diff --git a/docs/api/security.rst b/docs/api/security.rst
index 88086dbbf..116459226 100644
--- a/docs/api/security.rst
+++ b/docs/api/security.rst
@@ -80,15 +80,23 @@ Return Values
'george', 'read')`` that means deny access. A sequence of ACEs
makes up an ACL. It is a string, and its actual value is "Deny".
+.. autoclass:: Denied
+ :members: msg
+
+ .. automethod:: __new__
+
+.. autoclass:: Allowed
+ :members: msg
+
+ .. automethod:: __new__
+
.. autoclass:: ACLDenied
- :members:
+ :members: msg
-.. autoclass:: ACLAllowed
- :members:
+ .. automethod:: __new__
-.. autoclass:: Denied
- :members:
+.. autoclass:: ACLAllowed
+ :members: msg
-.. autoclass:: Allowed
- :members:
+ .. automethod:: __new__