diff options
-rw-r--r-- | docs/api/simplepolicies.rst | 7 | ||||
-rw-r--r-- | src/zope/security/simplepolicies.py | 11 |
2 files changed, 12 insertions, 6 deletions
diff --git a/docs/api/simplepolicies.rst b/docs/api/simplepolicies.rst index 8073f9d..37cdf17 100644 --- a/docs/api/simplepolicies.rst +++ b/docs/api/simplepolicies.rst @@ -1,6 +1,5 @@ -:mod:`zope.security.simplepolicies` -=================================== +============================== + zope.security.simplepolicies +============================== .. automodule:: zope.security.simplepolicies - :members: - :member-order: bysource diff --git a/src/zope/security/simplepolicies.py b/src/zope/security/simplepolicies.py index b2e8980..d1617ce 100644 --- a/src/zope/security/simplepolicies.py +++ b/src/zope/security/simplepolicies.py @@ -11,7 +11,13 @@ # FOR A PARTICULAR PURPOSE. # ############################################################################## -"""Simple 'ISecurityPolicy' implementations. +""" +Simple :class:`zope.security.interfaces.ISecurityPolicy` implementations. + +As a reminder, ``ISecurityPolicy`` objects are factories for producing +:class:`zope.security.interfaces.IInteraction` objects. That means +that the classes themselves are implementations of +``ISecurityPolicy``. """ import zope.interface @@ -25,7 +31,8 @@ from zope.security._definitions import system_user @zope.interface.provider(ISecurityPolicy) class ParanoidSecurityPolicy(object): """ - Prohibit all access by any non-system principal, unless the item is public. + Prohibit all access by any non-system principal, unless the item + is :data:`public <zope.security.checker.CheckerPublic>`. This means that if there are no participations (and hence no principals), then access is allowed. |