VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-06 14:04:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improve docs again

Browse Source
This commit is contained in:
David Halter
2012-12-27 19:48:19 +01:00
parent bf16a3a77a
commit 3f90055c69
2 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/plugin-api.rst
View File

@@ -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

12
jedi/api.py
View File

@@ -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