[doc] Document the user_data dictionnary content stable
authorChristophe de Vienne <christophe@unlish.com>
Fri, 25 Apr 2014 12:22:07 +0200
branchstable
changeset 9693 c7a184dd76b2
parent 9634 e01121bbd4fe
child 9694 c90107199dea
[doc] Document the user_data dictionnary content
req.py
--- a/req.py	Mon Apr 07 15:57:47 2014 +0200
+++ b/req.py	Fri Apr 25 12:22:07 2014 +0200
@@ -345,7 +345,20 @@
 
     @cached
     def user_data(self):
-        """returns a dictionary with this user's information"""
+        """returns a dictionary with this user's information.
+
+        The keys are :
+
+        login
+            The user login
+
+        name
+            The user name, returned by user.name()
+
+        email
+            The user principal email
+
+        """
         userinfo = {}
         user = self.user
         userinfo['login'] = user.login