[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/pas/interfaces.py Whitespace, docstring typos.

Florent Guillaume fg at nuxeo.com
Mon Oct 11 06:46:24 EDT 2004


Log message for revision 27957:
  Whitespace, docstring typos.
  


Changed:
  U   Zope3/trunk/src/zope/app/pas/interfaces.py


-=-
Modified: Zope3/trunk/src/zope/app/pas/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/pas/interfaces.py	2004-10-11 10:36:54 UTC (rev 27956)
+++ Zope3/trunk/src/zope/app/pas/interfaces.py	2004-10-11 10:46:24 UTC (rev 27957)
@@ -37,7 +37,10 @@
         )
 
 class IAuthenticatedPrincipalCreated(IPASPrincipalCreated):
-    """Event indicating that a principal was created by authenticating a reqest
+    """An authenticated principal object has been created
+
+    This event is generated when a principal has been created by
+    authenticating a request.
     """
 
     request = zope.interface.Attribute(
@@ -71,7 +74,7 @@
 
 class IPrincipalIdAwarePlugin(IPlugin):
     """Principal-Id aware plugin
-    
+
     A requirements of plugins that deal with principal ids is that
     principal ids must be unique within a PAS.  A PAS manager may want
     to use plugins to support multiple principal sources.  If the ids
@@ -90,7 +93,7 @@
         """Try to extract credentials from a request
 
         A return value of None indicates that no credentials could be
-        found. Any other return value is treated as valid credentials.        
+        found. Any other return value is treated as valid credentials.
         """
 
 class IAuthenticationPlugin(IPrincipalIdAwarePlugin):
@@ -137,7 +140,7 @@
         subscribers.  The contents of the info dictionary are defined
         by the authentication plugin used to authenticate the
         principal id.
-        
+
         If a principal is created, an IAuthenticatedPrincipalCreated
         event must be published and the principal is returned.  If no
         principal is created, return None.
@@ -171,7 +174,6 @@
     XXX Need to say more here.  We need to work out what to say. :)
     XXX In the mean time, see IQuerySchemaSearch.  Initially, search
     XXX plugins should provide IQuerySchemaSearch.
-    
     """
 
     def get(principal_id):
@@ -180,7 +182,6 @@
         If the principal id is valid, then return a dictionary
         containing supplemental information, if any.  Otherwise,
         return None.
-
         """
 
 class IQuerySchemaSearch(IPrincipalSearchPlugin):
@@ -193,19 +194,16 @@
     """)
 
     def search(query, start=None, batch_size=None):
-        """Search for principals 
+        """Search for principals
 
         The query argument is a mapping object with items defined by
-        the plugin's.  An iterable of principal ids should be returned.
+        the plugins.  An iterable of principal ids should be returned.
 
-        If the start argument is privided, then it should be an
+        If the start argument is provided, then it should be an
         integer and the given number of initial items should be
         skipped.
 
         If the batch_size argument is provided, then it should be an
         integer and no more than the given number of items should be
         returned.
-        
         """
-
-    



More information about the Zope3-Checkins mailing list