[Checkins] SVN: zope.security/trunk/ Silence Sphinx warnings.
Tres Seaver
cvs-admin at zope.org
Sun Dec 23 20:54:10 UTC 2012
Log message for revision 128877:
Silence Sphinx warnings.
Changed:
_U zope.security/trunk/
U zope.security/trunk/src/zope/security/interfaces.py
U zope.security/trunk/src/zope/security/management.py
U zope.security/trunk/src/zope/security/protectclass.py
-=-
Modified: zope.security/trunk/src/zope/security/interfaces.py
===================================================================
--- zope.security/trunk/src/zope/security/interfaces.py 2012-12-23 20:54:10 UTC (rev 128876)
+++ zope.security/trunk/src/zope/security/interfaces.py 2012-12-23 20:54:10 UTC (rev 128877)
@@ -65,12 +65,13 @@
def checkPermission(permission, object, interaction=None):
"""Return whether security policy allows permission on object.
- Arguments:
- permission -- A permission name
- object -- The object being accessed according to the permission
- interaction -- An interaction, which provides access to information
- such as authenticated principals. If it is None, the current
- interaction is used.
+ 'permission' is permission name.
+
+ 'object' is the object being accessed according to the permission.
+
+ 'interaction' is an interaction, providing access to information
+ such as authenticated principals. If it is None, the current
+ interaction is used.
"""
Modified: zope.security/trunk/src/zope/security/management.py
===================================================================
--- zope.security/trunk/src/zope/security/management.py 2012-12-23 20:54:10 UTC (rev 128876)
+++ zope.security/trunk/src/zope/security/management.py 2012-12-23 20:54:10 UTC (rev 128877)
@@ -105,13 +105,14 @@
def checkPermission(permission, object, interaction=None):
"""Return whether security policy allows permission on object.
- Arguments:
- permission -- A permission name
- object -- The object being accessed according to the permission
- interaction -- An interaction, which provides access to information
- such as authenticated principals. If it is None, the current
- interaction is used.
+ 'permission' is a permission name.
+ 'object' is the object being accessed according to the permission.
+
+ 'interaction' is an interaction, providing access to information
+ such as authenticated principals. If it is None, the current
+ interaction is used.
+
checkPermission is guaranteed to return True if permission is
CheckerPublic or None.
"""
Modified: zope.security/trunk/src/zope/security/protectclass.py
===================================================================
--- zope.security/trunk/src/zope/security/protectclass.py 2012-12-23 20:54:10 UTC (rev 128876)
+++ zope.security/trunk/src/zope/security/protectclass.py 2012-12-23 20:54:10 UTC (rev 128877)
@@ -57,7 +57,7 @@
protections[name] = permission
def protectLikeUnto(class_, like_unto):
- """Use the protections from like_unto for class_"""
+ """Use the protections from like_unto for the given class."""
unto_checker = getCheckerForInstancesOf(like_unto)
if unto_checker is None:
More information about the checkins
mailing list