mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-06 22:14:27 +08:00
Write a better introduction text
This commit is contained in:
@@ -1,21 +1,19 @@
|
|||||||
"""
|
"""
|
||||||
Jedi is a static analysis tool for Python that can be used in IDEs/editors. Its
|
Jedi is a static analysis tool for Python that can be used in IDEs/editors.
|
||||||
historic focus is autocompletion, but does static analysis for now as well.
|
Jedi has a focus on autocompletion and goto functionality. Jedi is fast and is
|
||||||
Jedi is fast and is very well tested. It understands Python on a deeper level
|
very well tested. It understands Python on a very deep level.
|
||||||
than all other static analysis frameworks for Python.
|
|
||||||
|
|
||||||
Jedi has support for two different goto functions. It's possible to search for
|
Jedi has support for different goto functions. It's possible to search for
|
||||||
related names and to list all names in a Python file and infer them. Jedi
|
usages and to list names in a Python file and get information about them. Jedi
|
||||||
understands docstrings and you can use Jedi autocompletion in your REPL as
|
understands docstrings.
|
||||||
well.
|
|
||||||
|
|
||||||
Jedi uses a very simple API to connect with IDE's. There's a reference
|
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>`_,
|
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.
|
which uses Jedi's autocompletion. We encourage you to use Jedi in your IDEs.
|
||||||
It's really easy.
|
There's also native support for Jedi within IPython and you can install it in
|
||||||
|
your REPL if you want.
|
||||||
|
|
||||||
To give you a simple example how you can use the Jedi library, here is an
|
Here's a simple example of the autocompletion feature:
|
||||||
example for the autocompletion feature:
|
|
||||||
|
|
||||||
>>> import jedi
|
>>> import jedi
|
||||||
>>> source = '''
|
>>> source = '''
|
||||||
|
|||||||
Reference in New Issue
Block a user