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

"Document" stubs for develops

Browse Source
This commit is contained in:
Dave Halter
2020-03-16 00:19:08 +01:00
parent 2feb0acd7d
commit 6220b20659
2 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/development.rst
View File

@@ -22,11 +22,12 @@ couldn't get rid of complexity. I know that **simple is better than complex**,
but unfortunately it sometimes requires complex solutions to understand complex but unfortunately it sometimes requires complex solutions to understand complex
systems. systems.
In five chapters I'm trying to describe the internals of |jedi|: In six chapters I'm trying to describe the internals of |jedi|:
- :ref:`The Jedi Core <core>` - :ref:`The Jedi Core <core>`
- :ref:`Core Extensions <core-extensions>` - :ref:`Core Extensions <core-extensions>`
- :ref:`Imports & Modules <imports-modules>` - :ref:`Imports & Modules <imports-modules>`
- :ref:`Stubs & Annotations <stubs>`
- :ref:`Caching & Recursions <caching-recursions>` - :ref:`Caching & Recursions <caching-recursions>`
- :ref:`Helper modules <dev-helpers>` - :ref:`Helper modules <dev-helpers>`
@@ -177,6 +178,12 @@ Imports (inference/imports.py)
.. automodule:: jedi.inference.imports .. automodule:: jedi.inference.imports
.. _stubs:
Stubs & Annotations (inference/gradual)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: jedi.inference.gradual
.. _caching-recursions: .. _caching-recursions:

4
jedi/inference/gradual/__init__.py
View File

@@ -0,0 +1,4 @@
"""
It is unfortunately not well documented how stubs and annotations work in Jedi.
If somebody needs an introduction, please let me know.
"""