diff --git a/docs/docs/development.rst b/docs/docs/development.rst index 22ce71e4..29ea8bb7 100644 --- a/docs/docs/development.rst +++ b/docs/docs/development.rst @@ -50,7 +50,7 @@ The core of Jedi consists of three parts: Most people are probably interested in :ref:`code evaluation `, because that's where all the magic happens. I need to introduce the :ref:`parser -` first, because :mod:`evaluate` uses it extensively. +` first, because :mod:`jedi.evaluate` uses it extensively. .. _parser: diff --git a/jedi/api/classes.py b/jedi/api/classes.py index 82c28c5c..c4d63f7c 100644 --- a/jedi/api/classes.py +++ b/jedi/api/classes.py @@ -1,7 +1,7 @@ """ -The :mod:`api_classes` module contains the return classes of the API. These -classes are the much bigger part of the whole API, because they contain the -interesting information about completion and goto operations. +The :mod:`jedi.api.classes` module contains the return classes of the API. +These classes are the much bigger part of the whole API, because they contain +the interesting information about completion and goto operations. """ import warnings @@ -10,7 +10,6 @@ from jedi import settings from jedi import common from jedi import cache from jedi.parser import representation as pr -from jedi.parser.tokenize import Token from jedi.evaluate import representation as er from jedi.evaluate import iterable from jedi.evaluate import imports diff --git a/jedi/evaluate/imports.py b/jedi/evaluate/imports.py index ef02f556..7e59f7f8 100644 --- a/jedi/evaluate/imports.py +++ b/jedi/evaluate/imports.py @@ -1,7 +1,7 @@ """ -:mod:`imports` is here to resolve import statements and return the -modules/classes/functions/whatever, which they stand for. However there's not -any actual importing done. This module is about finding modules in the +:mod:`jedi.evaluate.imports` is here to resolve import statements and return +the modules/classes/functions/whatever, which they stand for. However there's +not any actual importing done. This module is about finding modules in the filesystem. This can be quite tricky sometimes, because Python imports are not always that simple. diff --git a/jedi/evaluate/recursion.py b/jedi/evaluate/recursion.py index 15423d3d..58448082 100644 --- a/jedi/evaluate/recursion.py +++ b/jedi/evaluate/recursion.py @@ -3,9 +3,9 @@ Recursions are the recipe of |jedi| to conquer Python code. However, someone must stop recursions going mad. Some settings are here to make |jedi| stop at the right time. You can read more about them :ref:`here `. -Next to :mod:`cache` this module also makes |jedi| not thread-safe. Why? -``ExecutionRecursionDecorator`` uses class variables to count the function -calls. +Next to :mod:`jedi.evaluate.cache` this module also makes |jedi| not +thread-safe. Why? ``ExecutionRecursionDecorator`` uses class variables to +count the function calls. """ from jedi.parser import representation as pr from jedi import debug diff --git a/jedi/parser/__init__.py b/jedi/parser/__init__.py index 4326ed49..9acb7e99 100644 --- a/jedi/parser/__init__.py +++ b/jedi/parser/__init__.py @@ -1,7 +1,7 @@ """ The ``Parser`` tries to convert the available Python code in an easy to read format, something like an abstract syntax tree. The classes who represent this -tree, are sitting in the :mod:`parsing_representation` module. +tree, are sitting in the :mod:`jedi.parser.representation` module. The Python module ``tokenize`` is a very important part in the ``Parser``, because it splits the code into different words (tokens). Sometimes it looks a