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

improved readme

Browse Source
This commit is contained in:
David Halter
2012-06-24 20:25:48 +02:00
parent cffa236fc2
commit 2f70c67ada
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.mdown
View File

@@ -2,7 +2,10 @@ Jedi - a clever Python auto-completion
============================ ============================
** This is just a work-in-progress README. The auto-completion is not yet ** 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 Jedi is an autocompletion tool for Python. It should always work as good as
possible. It should provide completion wherever it is possible. 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! - 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 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** Python language, may lead to undefined behaviour of the completion. Jedi is
a Python compiler, that tries to correct you. It is a tool that wants to help **NOT** a Python compiler, that tries to correct you. It is a tool that wants
you. But **YOU** have to know Python, not Jedi. to help you. But **YOU** have to know Python, not Jedi.
Importing `numpy` can be quite slow sometimes, as well as loading the builtins 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 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. anymore.
From time to time Jedi might feel terribly slow. This behaviour is known, when From time to time Jedi might feel terribly slow. This behaviour is known, when