# HG changeset patch
# User Christophe de Vienne <christophe@unlish.com>
# Date 1398421327 -7200
# Node ID c7a184dd76b23cecc1949b8922ba74bd1dd2adbd
# Parent  e01121bbd4fea7078596bdebf13815be8370f62a
[doc] Document the user_data dictionnary content

diff -r e01121bbd4fe -r c7a184dd76b2 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