[Checkins] SVN: zope.security/trunk/ Normalize API doc names to match mdules.
Tres Seaver
cvs-admin at zope.org
Sun Dec 23 20:54:03 UTC 2012
Log message for revision 128866:
Normalize API doc names to match mdules.
Changed:
_U zope.security/trunk/
A zope.security/trunk/docs/api/permission.rst
D zope.security/trunk/docs/api/permissions.rst
U zope.security/trunk/docs/index.rst
-=-
Copied: zope.security/trunk/docs/api/permission.rst (from rev 128865, zope.security/trunk/docs/api/permissions.rst)
===================================================================
--- zope.security/trunk/docs/api/permission.rst (rev 0)
+++ zope.security/trunk/docs/api/permission.rst 2012-12-23 20:54:03 UTC (rev 128866)
@@ -0,0 +1,133 @@
+:mod:`zope.security.permission`
+===============================
+
+.. testsetup::
+
+ from zope.component.testing import setUp
+ setUp()
+
+.. autoclass:: zope.security.permission.Permission
+ :members:
+ :member-order: bysource
+
+
+.. autofunction:: zope.security.permission.checkPermission
+
+.. doctest::
+
+ >>> from zope.security.permission import checkPermission
+ >>> from zope.component import provideUtility
+ >>> from zope.security.interfaces import IPermission
+ >>> from zope.security.permission import Permission
+ >>> x = Permission('x')
+ >>> provideUtility(x, IPermission, 'x')
+
+ >>> checkPermission(None, 'x')
+ >>> checkPermission(None, 'y')
+ Traceback (most recent call last):
+ ...
+ ValueError: ('Undefined permission id', 'y')
+
+The :data:`zope.security.checker.CheckerPublic` permission always exists:
+
+.. doctest::
+
+ >>> from zope.security.checker import CheckerPublic
+ >>> checkPermission(None, CheckerPublic)
+
+
+.. autofunction:: zope.security.permission.allPermissions
+
+.. doctest::
+
+ >>> from zope.security.permission import allPermissions
+ >>> from zope.component import provideUtility
+ >>> y = Permission('y')
+ >>> provideUtility(y, IPermission, 'y')
+
+ >>> ids = list(allPermissions(None))
+ >>> ids.sort()
+ >>> ids
+ [u'x', u'y']
+
+
+.. autofunction:: zope.security.permission.PermissionsVocabulary
+
+To illustrate, we need to register the permissions vocabulary:
+
+.. doctest::
+
+ >>> from zope.security.permission import PermissionsVocabulary
+ >>> from zope.schema.vocabulary import _clear
+ >>> _clear()
+
+ >>> from zope.schema.vocabulary import getVocabularyRegistry
+ >>> registry = getVocabularyRegistry()
+ >>> registry.register('Permissions', PermissionsVocabulary)
+
+We can now lookup the permissions we created earlier using the vocabulary:
+
+.. doctest::
+
+ >>> vocab = registry.get(None, 'Permissions')
+ >>> vocab.getTermByToken('x').value is x
+ True
+ >>> vocab.getTermByToken('y').value is y
+ True
+
+
+.. autofunction:: zope.security.permission.PermissionIdsVocabulary
+
+To illustrate, we need to register the permission IDs vocabulary:
+
+.. doctest::
+
+ >>> from zope.security.permission import PermissionIdsVocabulary
+ >>> registry.register('Permission Ids', PermissionIdsVocabulary)
+
+ We also need to register the special 'zope.Public' permission:
+
+ >>> provideUtility(Permission('zope.Public'), IPermission, 'zope.Public')
+
+We can now lookup these permissions using the vocabulary:
+
+.. doctest::
+
+ >>> vocab = registry.get(None, 'Permission Ids')
+
+The non-public permissions 'x' and 'y' are string values:
+
+.. doctest::
+
+ >>> vocab.getTermByToken('x').value
+ u'x'
+ >>> vocab.getTermByToken('y').value
+ u'y'
+
+However, the public permission value is CheckerPublic:
+
+.. doctest::
+
+ >>> vocab.getTermByToken('zope.Public').value is CheckerPublic
+ True
+
+and its title is shortened:
+
+.. doctest::
+
+ >>> vocab.getTermByToken('zope.Public').title
+ u'Public'
+
+The terms are sorted by title except for the public permission, which is
+listed first:
+
+.. doctest::
+
+ >>> [term.title for term in vocab]
+ [u'Public', u'x', u'y']
+
+
+.. testcleanup::
+
+ from zope.component.testing import tearDown
+ tearDown()
Deleted: zope.security/trunk/docs/api/permissions.rst
===================================================================
--- zope.security/trunk/docs/api/permissions.rst 2012-12-23 20:54:02 UTC (rev 128865)
+++ zope.security/trunk/docs/api/permissions.rst 2012-12-23 20:54:03 UTC (rev 128866)
@@ -1,133 +0,0 @@
-:mod:`zope.security.permission`
-===============================
-
-.. testsetup::
-
- from zope.component.testing import setUp
- setUp()
-
-.. autoclass:: zope.security.permission.Permission
- :members:
- :member-order: bysource
-
-
-.. autofunction:: zope.security.permission.checkPermission
-
-.. doctest::
-
- >>> from zope.security.permission import checkPermission
- >>> from zope.component import provideUtility
- >>> from zope.security.interfaces import IPermission
- >>> from zope.security.permission import Permission
- >>> x = Permission('x')
- >>> provideUtility(x, IPermission, 'x')
-
- >>> checkPermission(None, 'x')
- >>> checkPermission(None, 'y')
- Traceback (most recent call last):
- ...
- ValueError: ('Undefined permission id', 'y')
-
-The :data:`zope.security.checker.CheckerPublic` permission always exists:
-
-.. doctest::
-
- >>> from zope.security.checker import CheckerPublic
- >>> checkPermission(None, CheckerPublic)
-
-
-.. autofunction:: zope.security.permission.allPermissions
-
-.. doctest::
-
- >>> from zope.security.permission import allPermissions
- >>> from zope.component import provideUtility
- >>> y = Permission('y')
- >>> provideUtility(y, IPermission, 'y')
-
- >>> ids = list(allPermissions(None))
- >>> ids.sort()
- >>> ids
- [u'x', u'y']
-
-
-.. autofunction:: zope.security.permission.PermissionsVocabulary
-
-To illustrate, we need to register the permissions vocabulary:
-
-.. doctest::
-
- >>> from zope.security.permission import PermissionsVocabulary
- >>> from zope.schema.vocabulary import _clear
- >>> _clear()
-
- >>> from zope.schema.vocabulary import getVocabularyRegistry
- >>> registry = getVocabularyRegistry()
- >>> registry.register('Permissions', PermissionsVocabulary)
-
-We can now lookup the permissions we created earlier using the vocabulary:
-
-.. doctest::
-
- >>> vocab = registry.get(None, 'Permissions')
- >>> vocab.getTermByToken('x').value is x
- True
- >>> vocab.getTermByToken('y').value is y
- True
-
-
-.. autofunction:: zope.security.permission.PermissionIdsVocabulary
-
-To illustrate, we need to register the permission IDs vocabulary:
-
-.. doctest::
-
- >>> from zope.security.permission import PermissionIdsVocabulary
- >>> registry.register('Permission Ids', PermissionIdsVocabulary)
-
- We also need to register the special 'zope.Public' permission:
-
- >>> provideUtility(Permission('zope.Public'), IPermission, 'zope.Public')
-
-We can now lookup these permissions using the vocabulary:
-
-.. doctest::
-
- >>> vocab = registry.get(None, 'Permission Ids')
-
-The non-public permissions 'x' and 'y' are string values:
-
-.. doctest::
-
- >>> vocab.getTermByToken('x').value
- u'x'
- >>> vocab.getTermByToken('y').value
- u'y'
-
-However, the public permission value is CheckerPublic:
-
-.. doctest::
-
- >>> vocab.getTermByToken('zope.Public').value is CheckerPublic
- True
-
-and its title is shortened:
-
-.. doctest::
-
- >>> vocab.getTermByToken('zope.Public').title
- u'Public'
-
-The terms are sorted by title except for the public permission, which is
-listed first:
-
-.. doctest::
-
- >>> [term.title for term in vocab]
- [u'Public', u'x', u'y']
-
-
-.. testcleanup::
-
- from zope.component.testing import tearDown
- tearDown()
Modified: zope.security/trunk/docs/index.rst
===================================================================
--- zope.security/trunk/docs/index.rst 2012-12-23 20:54:02 UTC (rev 128865)
+++ zope.security/trunk/docs/index.rst 2012-12-23 20:54:03 UTC (rev 128866)
@@ -1,13 +1,14 @@
-:mod:`zope.security`
-====================
+:mod:`zope.security` Documentation
+==================================
-Contents:
+API Reference
+-------------
.. toctree::
:maxdepth: 2
api/interfaces
- api/permissions
+ api/permission
More information about the checkins
mailing list