1
0
forked from VimPlug/jedi

Don't call it the plugin API anymore, that's confusing

This commit is contained in:
Dave Halter
2018-04-15 11:34:05 +02:00
parent 9465eb7881
commit 940a8c7c9c
5 changed files with 13 additions and 11 deletions

View File

@@ -1,6 +1,6 @@
.. include:: ../global.rst
.. _plugin-api-classes:
.. _api-classes:
API Return Classes
------------------

View File

@@ -1,7 +1,7 @@
.. include:: ../global.rst
The Plugin API
==============
The API
=======
.. currentmodule:: jedi
@@ -11,7 +11,7 @@ editors/IDE autocompletion
If you want to use |jedi|, you first need to ``import jedi``. You then have
direct access to the :class:`.Script`. You can then call the functions
documented here. These functions return :ref:`API classes
<plugin-api-classes>`.
<api-classes>`.
Deprecations
@@ -27,10 +27,12 @@ The deprecation process is as follows:
API documentation
-----------------
The API can generally
.. _api:
API Interface
~~~~~~~~~~~~~
Static Analysis Interface
~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: jedi

View File

@@ -7,7 +7,7 @@ Jedi Development
.. note:: This documentation is for Jedi developers who want to improve Jedi
itself, but have no idea how Jedi works. If you want to use Jedi for
your IDE, look at the `plugin api <plugin-api.html>`_.
your IDE, look at the `plugin api <api.html>`_.
Introduction
@@ -114,7 +114,7 @@ API (api.py and api_classes.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The API has been designed to be as easy to use as possible. The API
documentation can be found `here <plugin-api.html>`_. The API itself contains
documentation can be found `here <api.html>`_. The API itself contains
little code that needs to be mentioned here. Generally I'm trying to be
conservative with the API. I'd rather not add new API features if they are not
necessary, because it's much harder to deprecate stuff than to add it later.

View File

@@ -23,8 +23,8 @@ Docs
docs/usage
docs/installation
docs/features
docs/plugin-api
docs/plugin-api-classes
docs/api
docs/api-classes
docs/settings
docs/development
docs/testing

View File

@@ -8,7 +8,7 @@ very early development stage and needs much testing and improvement.
.. warning:: I won't do too much here, but if anyone wants to step in, please
do. Refactoring is none of my priorities
It uses the |jedi| `API <plugin-api.html>`_ and supports currently the
It uses the |jedi| `API <api.html>`_ and supports currently the
following functions (sometimes bug-prone):
- rename