Changeset 5904 for main/waeup.sirp/trunk/src/waeup/sirp

Timestamp:

30 Mar 2011, 22:41:02 (14 years ago)

Author:

uli

Message:

More docs.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/applicants/authentication.py (modified) (4 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/applicants/authentication.py

@@ -236 +236 @@
 class ApplicantsAuthUtility(grok.GlobalUtility):
     """A global utility that sets up any PAU passed.
+
+    The methods of this utility are called during setup of a new site
+    (`University`) instance and after the regular authentication
+    systems (regular users, officers, etc.) were set up.
     """
     grok.provides(IAuthPluginUtility)
@@ -243 +247 @@
         """Register our local applicants specific PAU components.
 
-        Applicants provider their own authentication system resulting
+        Applicants provide their own authentication system resulting
         in a specialized credentials plugin and a specialized
         authenticator plugin.
@@ -250 +254 @@
         be consulted when trying to authenticate a user.
 
-        We stack our local plugins on top of the list, so that other
-        authentication mechanisms (the normal user authentication for
-        instance) have precedence and to avoid "account-shadowing".
+        We stack our local plugins at end of the plugin list, so that
+        other authentication mechanisms (the normal user
+        authentication for instance) have precedence and to avoid
+        "account-shadowing".
         """
         # The local credentials plugin is registered under the name
@@ -264 +269 @@
     def unregister(self, pau):
         return pau
-    
-    
+
+
 def principal_id(access_code):
     """Get a principal ID for applicants.