VimPlug/jedi-fork
1
0
Fork 0
forked from VimPlug/jedi
Code Pull Requests Activity

Fix and improve Statement.__doc__

Browse Source 
- The type of `set_vars` and `used_vars` were wrong.
- ":param ...:" was used instead of ":type ...:".
- The parameter table is aligned to make it easier to read.
This commit is contained in:
Takafumi Arakaki
2013-03-03 14:07:07 +01:00
parent 90c800b257
commit 700493cac8
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
jedi/parsing_representation.py
View File

@@ -663,14 +663,18 @@ class Statement(Simple):
stores pretty much all the Python code, except functions, classes, imports, stores pretty much all the Python code, except functions, classes, imports,
and flow functions like if, for, etc. and flow functions like if, for, etc.
:param set_vars: The variables which are defined by the statement. :type set_vars: list of :class:`Name`
:param set_vars: str :param set_vars: The variables which are defined by the statement.
:param used_vars: The variables which are used by the statement. :type used_vars: list of :class:`Name`
:param used_vars: str :param used_vars: The variables which are used by the statement.
:param token_list: Token list which is also peppered with Name. :type token_list: list
:param token_list: list :param token_list:
:param start_pos: Position (line, column) of the Statement. List of tokens or names. Each element is either an instance
:type start_pos: tuple(int, int) of :class:`Name` or a tuple of token type value (e.g.,
:data:`tokenize.NUMBER`), token string (e.g., ``'='``), and
start position (e.g., ``(1, 0)``).
:type start_pos: 2-tuple of int
:param start_pos: Position (line, column) of the Statement.
""" """
__slots__ = ('token_list', 'used_vars', __slots__ = ('token_list', 'used_vars',
'set_vars', '_commands', '_assignment_details') 'set_vars', '_commands', '_assignment_details')