1
0
forked from VimPlug/jedi

improved evaluate docstring

This commit is contained in:
David Halter
2013-02-05 00:39:48 +01:00
parent 4fc350f637
commit ee9676a5d7
+18 -2
View File
@@ -1,6 +1,22 @@
""" """
This is the core part of jedi. Most of the logic, how to evaluate certain .. warning:: I know this module is very messy. It's hard to write proper code
objects (imports, etc.) is here. if so much of your work relies on try & error. Sometimes it's just not
possible for a small mind like mine to understand the problem, because
it happens after a 50 function calls deep recursion. I know refactoring
is necessary, but it's not that easy to find that time.
Evaluation of Python code in |jedi| is based on three assumptions:
* Code is recursive (to weaken this assumption, the :mod:`dynamic` module
exists).
* No magic is being used:
- metaclasses
- ``setattr()`` / ``__import__()``
- writing to ``globals()``, ``locals()``, ``object.__dict__``
* The programmer is not a total dick, e.g. like `this
<https://github.com/davidhalter/jedi/issues/24>`_ :-)
The functions should be described in their docstrings. However, there are some The functions should be described in their docstrings. However, there are some
classes, which are used to store the values. After those classes, there are the classes, which are used to store the values. After those classes, there are the