mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-07 22:44:27 +08:00
improved readme
This commit is contained in:
13
README.mdown
13
README.mdown
@@ -2,7 +2,10 @@ Jedi - a clever Python auto-completion
|
||||
============================
|
||||
|
||||
** This is just a work-in-progress README. The auto-completion is not yet
|
||||
finished (and the README neither :-)) **
|
||||
finished (and the README neither :-)) The completion is currently in a
|
||||
pre-alpha state and needs serious testing, as well as some features. If you
|
||||
really want to try it, you can, but I won't be very supportive, just wait 1-2
|
||||
months more. **
|
||||
|
||||
Jedi is an autocompletion tool for Python. It should always work as good as
|
||||
possible. It should provide completion wherever it is possible.
|
||||
@@ -42,13 +45,13 @@ nice in Python 2. To keep things simple, some things have been held back:
|
||||
- Exceptions are only looked at in the form of `Exception as e`, no comma!
|
||||
|
||||
Syntax Errors and other strange stuff, that is defined differently in the
|
||||
Python language, may lead to undefined behaviour of the completion. Jedi is **NOT**
|
||||
a Python compiler, that tries to correct you. It is a tool that wants to help
|
||||
you. But **YOU** have to know Python, not Jedi.
|
||||
Python language, may lead to undefined behaviour of the completion. Jedi is
|
||||
**NOT** a Python compiler, that tries to correct you. It is a tool that wants
|
||||
to help you. But **YOU** have to know Python, not Jedi.
|
||||
|
||||
Importing `numpy` can be quite slow sometimes, as well as loading the builtins
|
||||
the first time. If you want to speed it up, you could write import hooks in
|
||||
jedi, which preload this stuff. However, once loaded, this is not a problem
|
||||
jedi, which preloads this stuff. However, once loaded, this is not a problem
|
||||
anymore.
|
||||
|
||||
From time to time Jedi might feel terribly slow. This behaviour is known, when
|
||||
|
||||
Reference in New Issue
Block a user