req.py
changeset 9770 112c884b2d8d
parent 9720 a7210c912507
parent 9700 da7d341cca76
child 9821 2077c8da1893
--- a/req.py	Wed Apr 09 17:29:25 2014 +0200
+++ b/req.py	Tue Jun 10 09:49:45 2014 +0200
@@ -299,7 +299,7 @@
         return u'%s%s?%s' % (base_url, path, self.build_url_params(**kwargs))
 
     def build_url_params(self, **kwargs):
-        """return encoded params to incorporate them in an URL"""
+        """return encoded params to incorporate them in a URL"""
         args = []
         for param, values in kwargs.iteritems():
             if not isinstance(values, (list, tuple)):
@@ -365,7 +365,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