[doc] Add a small docstring to RQLExpression constructor stable
authorAnthony Truchet <anthony.truchet@logilab.fr>
Thu, 12 Jan 2012 13:04:59 +0100
branchstable
changeset 8160 e53c003e3d37
parent 8157 098c83a99807
child 8164 1de67012837b
[doc] Add a small docstring to RQLExpression constructor
schema.py
--- a/schema.py	Wed Jan 11 18:28:17 2012 +0100
+++ b/schema.py	Thu Jan 12 13:04:59 2012 +0100
@@ -666,6 +666,12 @@
     full_rql = None
 
     def __init__(self, expression, mainvars, eid):
+        """
+        :type mainvars: sequence of RQL variables' names. Can be provided as a 
+                        comma separated string.
+        :param mainvars: names of the variables being selected.
+
+        """
         self.eid = eid # eid of the entity representing this rql expression
         assert mainvars, 'bad mainvars %s' % mainvars
         if isinstance(mainvars, basestring):