From 940a8c7c9cc7821cf81ccdb1634393c020824078 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Sun, 15 Apr 2018 11:34:05 +0200 Subject: [PATCH] Don't call it the plugin API anymore, that's confusing --- .../docs/{plugin-api-classes.rst => api-classes.rst} | 2 +- docs/docs/{plugin-api.rst => api.rst} | 12 +++++++----- docs/docs/development.rst | 4 ++-- docs/index.rst | 4 ++-- jedi/refactoring.py | 2 +- 5 files changed, 13 insertions(+), 11 deletions(-) rename docs/docs/{plugin-api-classes.rst => api-classes.rst} (84%) rename docs/docs/{plugin-api.rst => api.rst} (95%) diff --git a/docs/docs/plugin-api-classes.rst b/docs/docs/api-classes.rst similarity index 84% rename from docs/docs/plugin-api-classes.rst rename to docs/docs/api-classes.rst index 74eb28b4..9feec1c6 100644 --- a/docs/docs/plugin-api-classes.rst +++ b/docs/docs/api-classes.rst @@ -1,6 +1,6 @@ .. include:: ../global.rst -.. _plugin-api-classes: +.. _api-classes: API Return Classes ------------------ diff --git a/docs/docs/plugin-api.rst b/docs/docs/api.rst similarity index 95% rename from docs/docs/plugin-api.rst rename to docs/docs/api.rst index 9515233f..60890e6b 100644 --- a/docs/docs/plugin-api.rst +++ b/docs/docs/api.rst @@ -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 -`. +`. 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 diff --git a/docs/docs/development.rst b/docs/docs/development.rst index 90027ecd..17e51d97 100644 --- a/docs/docs/development.rst +++ b/docs/docs/development.rst @@ -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 `_. + your IDE, look at the `plugin api `_. 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 `_. The API itself contains +documentation can be found `here `_. 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. diff --git a/docs/index.rst b/docs/index.rst index de92fa72..57072abf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/jedi/refactoring.py b/jedi/refactoring.py index 86f60414..6c1d74d1 100644 --- a/jedi/refactoring.py +++ b/jedi/refactoring.py @@ -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 `_ and supports currently the +It uses the |jedi| `API `_ and supports currently the following functions (sometimes bug-prone): - rename