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

last documentation fixes

Browse Source
This commit is contained in:
David Halter
2013-08-31 18:59:29 +04:30
parent 0fd0b0efc6
commit 7b1290a182
3 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/plugin-api-classes.rst
+2
View File
@@ -1,5 +1,7 @@
.. include:: ../global.rst .. include:: ../global.rst
.. _plugin-api-classes:
API Return Classes API Return Classes
------------------ ------------------
docs/docs/plugin-api.rst
+4 -2
View File
@@ -8,8 +8,10 @@ The Plugin API
Note: This documentation is for Plugin developers, who want to improve their Note: This documentation is for Plugin developers, who want to improve their
editors/IDE autocompletion editors/IDE autocompletion
If you want to use |jedi|, you first need to If you want to use |jedi|, you first need to ``import jedi``. You then have
``import jedi``. You then have direct access to the :class:`.Script`. direct access to the :class:`.Script`. You can then call the functions
documented here. These functions return :ref:`API classes
<plugin-api-classes>`.
API documentation API documentation
docs/docs/usage.rst
+1 -1
View File
@@ -5,7 +5,7 @@ End User Usage
If you are a not an IDE Developer, than chances are pretty high, that you just 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 want to use |jedi| as a browser plugin or in the shell. Yes that's :ref:`also
possible <repl-completion>``! possible <repl-completion>`!
|jedi| is relatively young and can be used in a variety of Plugins and |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 Software. If your Editor/IDE is not among them, recommend |jedi| to your IDE