1
0
forked from VimPlug/jedi

make docstrings ready for sphinx

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

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>.
**The structure of the following script:**
A Scope has
A Scope has:
- imports (Import)
- subscopes (Scope, Class, Function, Flow)
- statements (Statement)
All these objects have `Name`s. `Call` and `Array` are used as detail objects
of a statement.
All these objects have ``Name``. ``Call`` and ``Array`` are used as detail
objects of a statement.
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
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,
property, cleandoc, Python3Method)