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

Make the jedi documentation more concise

Browse Source
This commit is contained in:
Dave Halter
2019-06-19 18:20:48 +02:00
parent b71a851081
commit 5f81353182
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
jedi/__init__.py
View File

@@ -1,17 +1,16 @@
"""
Jedi is a static analysis tool for Python that can be used in IDEs/editors.
Jedi has a focus on autocompletion and goto functionality. Jedi is fast and is
very well tested. It understands Python on a very deep level.
very well tested. It understands Python and stubs on a deep level.
Jedi has support for different goto functions. It's possible to search for
usages and to list names in a Python file and get information about them. Jedi
understands docstrings.
usages and list names in a Python file to get information about them.
Jedi uses a very simple API to connect with IDE's. There's a reference
implementation as a `VIM-Plugin <https://github.com/davidhalter/jedi-vim>`_,
which uses Jedi's autocompletion. We encourage you to use Jedi in your IDEs.
There's also native support for Jedi within IPython and you can install it in
your REPL if you want.
Autocompletion in your REPL is also possible, IPython uses it natively and for
the CPython REPL you have to install it.
Here's a simple example of the autocompletion feature: