VimPlug/jedi-fork
1
0
Fork 0
forked from VimPlug/jedi
Code Pull Requests Activity

Better overview over functions in the documentation

Browse Source
This commit is contained in:
Dave Halter
2018-04-15 12:11:06 +02:00
parent b531b6f4fd
commit a711c29b59
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/api.rst
View File

@@ -27,7 +27,14 @@ The deprecation process is as follows:
API documentation
-----------------
The API can generally
The API consists of a few different parts:
- The main starting points for completions/goto: :class:`.Script` and :class:`.Interpreter`
- Helpful functions: :func:`.names`, :func:`.preload_module` and
:func:`.set_debug_function`
- :ref:`API Result Classes <api-classes>`
- :ref:`Python Versions/Virtualenv Support <environments>` with functions like
:func:`.find_system_environments` and :func:`.find_virtualenvs`
.. _api: