From 7b1290a1828c72714917976cabf12254d7b7ba23 Mon Sep 17 00:00:00 2001 From: David Halter Date: Sat, 31 Aug 2013 18:59:29 +0430 Subject: [PATCH] last documentation fixes --- docs/docs/plugin-api-classes.rst | 2 ++ docs/docs/plugin-api.rst | 6 ++++-- docs/docs/usage.rst | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/docs/plugin-api-classes.rst b/docs/docs/plugin-api-classes.rst index 12669c63..4622f645 100644 --- a/docs/docs/plugin-api-classes.rst +++ b/docs/docs/plugin-api-classes.rst @@ -1,5 +1,7 @@ .. include:: ../global.rst +.. _plugin-api-classes: + API Return Classes ------------------ diff --git a/docs/docs/plugin-api.rst b/docs/docs/plugin-api.rst index 4826970a..0dca84e7 100644 --- a/docs/docs/plugin-api.rst +++ b/docs/docs/plugin-api.rst @@ -8,8 +8,10 @@ The Plugin API Note: This documentation is for Plugin developers, who want to improve their editors/IDE autocompletion -If you want to use |jedi|, you first need to -``import jedi``. You then have direct access to the :class:`.Script`. +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 +`. API documentation diff --git a/docs/docs/usage.rst b/docs/docs/usage.rst index 1834e4c7..d071b97a 100644 --- a/docs/docs/usage.rst +++ b/docs/docs/usage.rst @@ -5,7 +5,7 @@ End User Usage If you are a not an IDE Developer, than chances are pretty high, that you just want to use |jedi| as a browser plugin or in the shell. Yes that's :ref:`also -possible ``! +possible `! |jedi| is relatively young and can be used in a variety of Plugins and Software. If your Editor/IDE is not among them, recommend |jedi| to your IDE