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

make docstrings ready for sphinx

Browse Source
This commit is contained in:
David Halter
2013-02-04 14:23:50 +01:00
parent 3faf50049b
commit 9eec549a39
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
jedi/evaluate.py
View File

@@ -8,7 +8,7 @@ search functions `get_names_for_scope` and `get_scopes_for_name`. At the end
there are the `follow_` functions, which evaluate a statement, or parts of a there are the `follow_` functions, which evaluate a statement, or parts of a
statement. statement.
TODO nonlocal statement, needed or can be ignored? (py3k) .. todo:: nonlocal statement, needed or can be ignored? (py3k)
""" """
from _compatibility import next, property, hasattr, is_py3k, use_metaclass, \ from _compatibility import next, property, hasattr, is_py3k, use_metaclass, \
unicode unicode

11
jedi/parsing.py
View File

@@ -13,18 +13,21 @@ This original codebase of this parser, which has been refactored and heavily
changed, was programmed by Aaron Griffin <aaronmgriffin@gmail.com>. changed, was programmed by Aaron Griffin <aaronmgriffin@gmail.com>.
**The structure of the following script:** **The structure of the following script:**
A Scope has
A Scope has:
- imports (Import) - imports (Import)
- subscopes (Scope, Class, Function, Flow) - subscopes (Scope, Class, Function, Flow)
- statements (Statement) - statements (Statement)
All these objects have `Name`s. `Call` and `Array` are used as detail objects All these objects have ``Name``. ``Call`` and ``Array`` are used as detail
of a statement. objects of a statement.
All those classes are being generated by PyFuzzyParser, which takes python text All those classes are being generated by PyFuzzyParser, which takes python text
as input and ignores just all the non-python stuff. Basically you could feed it as input and ignores just all the non-python stuff. Basically you could feed it
a perl script, and it should still work (which means throw no error). a perl script, and it should still work (which means throw no error).
TODO remove docstr params from Scope.__init__()
.. todo:: remove docstr params from Scope.__init__()
""" """
from _compatibility import (next, literal_eval, StringIO, unicode, from _compatibility import (next, literal_eval, StringIO, unicode,
property, cleandoc, Python3Method) property, cleandoc, Python3Method)