diff --git a/docs/source/plugin-api.rst b/docs/source/plugin-api.rst index e7c0664d..899308b0 100644 --- a/docs/source/plugin-api.rst +++ b/docs/source/plugin-api.rst @@ -3,9 +3,11 @@ The plugin API .. currentmodule:: jedi +Note: This documentation is for Plugin developers, who want to improve their +editors/IDE autocompletion + If you want to set up an editor/IDE-plugin with **Jedi**, you first need to -``import jedi``. You then have direct access to the :class:`.Script`, -:class:`.NotFoundError` and :func:`.set_debug_function` objects. +``import jedi``. You then have direct access to the :class:`.Script`. API documentation diff --git a/jedi/api.py b/jedi/api.py index 3aaf8948..914859aa 100644 --- a/jedi/api.py +++ b/jedi/api.py @@ -1,8 +1,9 @@ """ -The api basically only provides one class. You can create a ``Script`` and use -it's complete/goto/etc functions. Additionally you can add a debug function -with ``set_debug_function`` and catch ``NotFoundError``, which is being raised -if your completion is impossible. +The api basically only provides one class. You can create a :class:`Script` and +use it's ``complete`` / ``goto`` / etc functions. +Additionally you can add a debug function with :func:`set_debug_function` and +catch :exc:`NotFoundError` which is being raised if your completion is +impossible. """ from __future__ import with_statement __all__ = ['Script', 'NotFoundError', 'set_debug_function'] @@ -33,7 +34,8 @@ class NotFoundError(Exception): class Script(object): """ - A Script is the base for a completion, goto or whatever call. + A Script is the base for a completion, goto or whatever you want to do with + jedi. :param source: The source code of the current file, separated by newlines. :type source: string