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

some docstring improvements

Browse Source
This commit is contained in:
David Halter
2013-01-04 20:07:20 +01:00
parent 89bd32e0d7
commit 3f5e9d6bca
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
jedi/api.py
View File

@@ -39,17 +39,17 @@ class Script(object):
|jedi|. |jedi|.
:param source: The source code of the current file, separated by newlines. :param source: The source code of the current file, separated by newlines.
:type source: string :type source: str
:param line: The line to perform actions on (starting with 1). :param line: The line to perform actions on (starting with 1).
:type line: int :type line: int
:param col: The column of the cursor (starting with 0). :param col: The column of the cursor (starting with 0).
:type col: int :type col: int
:param source_path: The path of the file in the file system, or ``''`` if :param source_path: The path of the file in the file system, or ``''`` if
it hasn't been saved yet. it hasn't been saved yet.
:type source_path: string or None :type source_path: str or None
:param source_encoding: The encoding of ``source``, if it is not a :param source_encoding: The encoding of ``source``, if it is not a
``unicode`` object (default ``'utf-8'``). ``unicode`` object (default ``'utf-8'``).
:type source_encoding: string :type source_encoding: str
""" """
def __init__(self, source, line, column, source_path, def __init__(self, source, line, column, source_path,
source_encoding='utf-8'): source_encoding='utf-8'):

4
jedi/parsing.py
View File

@@ -326,7 +326,7 @@ class Class(Scope):
Used to store the parsed contents of a python class. Used to store the parsed contents of a python class.
:param name: The Class name. :param name: The Class name.
:type name: string :type name: str
:param supers: The super classes of a Class. :param supers: The super classes of a Class.
:type supers: list :type supers: list
:param start_pos: The start position (line, column) of the class. :param start_pos: The start position (line, column) of the class.
@@ -359,7 +359,7 @@ class Function(Scope):
Used to store the parsed contents of a python function. Used to store the parsed contents of a python function.
:param name: The Function name. :param name: The Function name.
:type name: string :type name: str
:param params: The parameters (Statement) of a Function. :param params: The parameters (Statement) of a Function.
:type params: list :type params: list
:param start_pos: The start position (line, column) the Function. :param start_pos: The start position (line, column) the Function.