From 25af28946ec7251bbf668299cfc8fed59197830b Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Mon, 16 Mar 2020 09:35:47 +0100 Subject: [PATCH] Docs: API overview --- docs/docs/api.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/docs/api.rst b/docs/docs/api.rst index 06ef9859..8e04017c 100644 --- a/docs/docs/api.rst +++ b/docs/docs/api.rst @@ -10,10 +10,13 @@ API Overview The API consists of a few different parts: -- The main starting points for complete/goto: :class:`.Script` and :class:`.Interpreter` +- The main starting points for complete/goto: :class:`.Script` and + :class:`.Interpreter`. If you work with Jedi you want to understand these + classes first. - :ref:`API Result Classes ` - :ref:`Python Versions/Virtualenv Support ` with functions like :func:`.find_system_environments` and :func:`.find_virtualenvs` +- A way to work with different :ref:`Folders / Projects ` - Helpful functions: :func:`.preload_module` and :func:`.set_debug_function` Script