VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-08 06:44:46 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve internal module links for sphinx documentation

Browse Source
This commit is contained in:
Dave Halter
2014-03-11 15:45:54 +01:00
parent cffdcd2571
commit 5764e760d2
5 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/development.rst
View File

@@ -50,7 +50,7 @@ The core of Jedi consists of three parts:
Most people are probably interested in :ref:`code evaluation <evaluate>`, Most people are probably interested in :ref:`code evaluation <evaluate>`,
because that's where all the magic happens. I need to introduce the :ref:`parser because that's where all the magic happens. I need to introduce the :ref:`parser
<parser>` first, because :mod:`evaluate` uses it extensively. <parser>` first, because :mod:`jedi.evaluate` uses it extensively.
.. _parser: .. _parser:

7
jedi/api/classes.py
View File

@@ -1,7 +1,7 @@
""" """
The :mod:`api_classes` module contains the return classes of the API. These The :mod:`jedi.api.classes` module contains the return classes of the API.
classes are the much bigger part of the whole API, because they contain the These classes are the much bigger part of the whole API, because they contain
interesting information about completion and goto operations. the interesting information about completion and goto operations.
""" """
import warnings import warnings
@@ -10,7 +10,6 @@ from jedi import settings
from jedi import common from jedi import common
from jedi import cache from jedi import cache
from jedi.parser import representation as pr from jedi.parser import representation as pr
from jedi.parser.tokenize import Token
from jedi.evaluate import representation as er from jedi.evaluate import representation as er
from jedi.evaluate import iterable from jedi.evaluate import iterable
from jedi.evaluate import imports from jedi.evaluate import imports

6
jedi/evaluate/imports.py
View File

@@ -1,7 +1,7 @@
""" """
:mod:`imports` is here to resolve import statements and return the :mod:`jedi.evaluate.imports` is here to resolve import statements and return
modules/classes/functions/whatever, which they stand for. However there's not the modules/classes/functions/whatever, which they stand for. However there's
any actual importing done. This module is about finding modules in the 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 filesystem. This can be quite tricky sometimes, because Python imports are not
always that simple. always that simple.

6
jedi/evaluate/recursion.py
View File

@@ -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 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 <settings-recursion>`. the right time. You can read more about them :ref:`here <settings-recursion>`.
Next to :mod:`cache` this module also makes |jedi| not thread-safe. Why? Next to :mod:`jedi.evaluate.cache` this module also makes |jedi| not
``ExecutionRecursionDecorator`` uses class variables to count the function thread-safe. Why? ``ExecutionRecursionDecorator`` uses class variables to
calls. count the function calls.
""" """
from jedi.parser import representation as pr from jedi.parser import representation as pr
from jedi import debug from jedi import debug

2
jedi/parser/__init__.py
View File

@@ -1,7 +1,7 @@
""" """
The ``Parser`` tries to convert the available Python code in an easy to read 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 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``, 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 because it splits the code into different words (tokens). Sometimes it looks a