From b6ecd71f161b54b8689a5306fd3014aad2d2491b Mon Sep 17 00:00:00 2001 From: David Halter Date: Sun, 3 Feb 2013 20:14:08 +0100 Subject: [PATCH] use first lines of readme as jedi docstring --- jedi/__init__.py | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/jedi/__init__.py b/jedi/__init__.py index 42ea6850..47aaa93a 100644 --- a/jedi/__init__.py +++ b/jedi/__init__.py @@ -1,9 +1,25 @@ """ -Jedi is an autocompletion library for Python. It also offers additional -services such as ``goto``, ``pydoc support`` and ``renaming`` as well as other -IDE helpers. +Jedi is an autocompletion tool for Python that can be used in IDEs/editors. +Jedi works. Jedi is fast. It understands all of the basic Python syntax +elements including many builtin functions. -To give you a simple example how you can use the jedi library, here is an +Additionaly, Jedi suports two different goto functions and has support for +renaming as well as Pydoc support and some other IDE features. + +Jedi uses a very simple API to connect with IDE's. There's a reference +implementation as a `VIM-Plugin `_, +which uses Jedi's autocompletion. I encourage you to use Jedi in your IDEs. +It's really easy. If there are any problems (also with licensing), just contact +me. + +Jedi can be used with the following plugins/software: + +- `VIM-Plugin `_ +- `Emacs-Plugin `_ +- `Sublime-Plugin `_ +- `wdb (web debugger) `_ + +To give you a simple example how you can use the Jedi library, here is an example for the autocompletion feature: >>> import jedi