From 6220b20659d9e946b0ca5a3e3b88e4131f97bc88 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Mon, 16 Mar 2020 00:19:08 +0100 Subject: [PATCH] "Document" stubs for develops --- docs/docs/development.rst | 9 ++++++++- jedi/inference/gradual/__init__.py | 4 ++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/docs/development.rst b/docs/docs/development.rst index 9b0e8248..ec981e8b 100644 --- a/docs/docs/development.rst +++ b/docs/docs/development.rst @@ -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 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 ` - :ref:`Core Extensions ` - :ref:`Imports & Modules ` +- :ref:`Stubs & Annotations ` - :ref:`Caching & Recursions ` - :ref:`Helper modules ` @@ -177,6 +178,12 @@ Imports (inference/imports.py) .. automodule:: jedi.inference.imports +.. _stubs: + +Stubs & Annotations (inference/gradual) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: jedi.inference.gradual .. _caching-recursions: diff --git a/jedi/inference/gradual/__init__.py b/jedi/inference/gradual/__init__.py index e69de29b..5c86b7b3 100644 --- a/jedi/inference/gradual/__init__.py +++ b/jedi/inference/gradual/__init__.py @@ -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. +"""