Changeset 7186 for main/waeup.sirp/trunk/src/waeup/sirp/permissions.txt

Timestamp:

24 Nov 2011, 11:31:04 (13 years ago)

Author:

Henrik Bettermann

Message:

Rename functions according to the WAeUP style guide:

functions and methods with property decorator with underscore

methods with CamelCase

File:

• main/waeup.sirp/trunk/src/waeup/sirp/permissions.txt (modified) (2 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/permissions.txt

@@ -13 +13 @@
 roles.
 
-:func:`getAllRoles`
--------------------
+:func:`get_all_roles`
+---------------------
 
 Gives us all roles defined in a WAeUP SIRP portal. We get tuples of
@@ -24 +24 @@
 with the ZCA (a string) and ``<ROLE>`` is the real role object.
 
-    >>> from waeup.sirp.permissions import getAllRoles
-    >>> getAllRoles()
+    >>> from waeup.sirp.permissions import get_all_roles
+    >>> get_all_roles()
     <generator object...at 0x...>
 
-    >>> sorted(list(getAllRoles()))
+    >>> sorted(list(get_all_roles()))
     [(u'waeup.ACManager', <waeup.sirp.permissions.ACManager object at 0x...]
 
-:func:`getWAeUPRoles`
----------------------
+:func:`get_waeup_roles`
+-----------------------
 
 Gives us all roles, except the WAeUP specific roles. We can get a list
 with or without local roles:
 
-    >>> from waeup.sirp.permissions import getWAeUPRoles
-    >>> len(list(getWAeUPRoles()))
+    >>> from waeup.sirp.permissions import get_waeup_roles
+    >>> len(list(get_waeup_roles()))
     10
 
-    >>> len(list(getWAeUPRoles(also_local=True)))
+    >>> len(list(get_waeup_roles(also_local=True)))
     16
 
 
-:func:`getRoleNames`
---------------------
+:func:`get_waeup_role_names`
+----------------------------
 
 We can get all role names defined in a WAeUP portal (except 'local'
 roles that are meant not to be assigned globally):
 
-    >>> from waeup.sirp.permissions import getWAeUPRoleNames
-    >>> list(getWAeUPRoleNames())
+    >>> from waeup.sirp.permissions import get_waeup_role_names
+    >>> list(get_waeup_role_names())
     [u'waeup.ACManager', u'waeup.AcademicsOfficer',
      u'waeup.AccommodationOfficer', u'waeup.Applicant',