pyramid_cubicweb/auth.py
changeset 11537 caf268942436
parent 11533 4ced3782b90f
child 11561 25d93d14f8b6
--- a/pyramid_cubicweb/auth.py	Mon Jan 05 12:02:01 2015 +0100
+++ b/pyramid_cubicweb/auth.py	Sat Jan 03 22:06:03 2015 +0100
@@ -18,6 +18,8 @@
 
     Meaning, the last_login_time is updated reissue_time seconds (maximum)
     before the last request by the user.
+
+    Usually used via :func:`includeme`.
     """
 
     def remember(self, request, principal, **kw):
@@ -37,6 +39,12 @@
 
 
 def includeme(config):
+    """ Activate the CubicWeb AuthTkt authentication policy.
+
+    Usually called via ``config.include('pyramid_cubicweb.auth')``.
+
+    See also :ref:`defaults_module`
+    """
     secret = config.registry['cubicweb.config']['pyramid-auth-secret']
 
     if not secret: