forked from VimPlug/jedi-vim
Added notes about conflict with python-mode (refs #163)
This commit is contained in:
21
README.rst
21
README.rst
@@ -64,9 +64,10 @@ Apart from that, jedi-vim supports the following commands
|
||||
Installation
|
||||
============
|
||||
|
||||
You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ to
|
||||
install jedi in VIM. Also you need a VIM version that was compiled with
|
||||
``+python``, which is typical for most distributions on Linux.
|
||||
You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ or
|
||||
`vundle <https://github.com/gmarik/vundle>`_ to install jedi in VIM. Also you
|
||||
need a VIM version that was compiled with ``+python``, which is typical for most
|
||||
distributions on Linux.
|
||||
|
||||
The first thing you need after that is an up-to-date version of Jedi. You can
|
||||
either get it via ``pip install jedi`` or with ``git submodule update --init``
|
||||
@@ -75,6 +76,10 @@ in your jedi-vim repository.
|
||||
On Arch Linux, you can also install jedi-vim from AUR: `vim-jedi
|
||||
<https://aur.archlinux.org/packages/vim-jedi/>`__.
|
||||
|
||||
Note that the `python-mode <https://github.com/klen/python-mode>`_ VIM plugin seems
|
||||
to conflict with jedi-vim, therefore you should disable it before enabling
|
||||
jedi-vim.
|
||||
|
||||
|
||||
Settings
|
||||
========
|
||||
@@ -157,6 +162,16 @@ Don't even think about changing the Jedi command to ``<Tab>``,
|
||||
use `supertab <https://github.com/ervandew/supertab>`_!
|
||||
|
||||
|
||||
The completion is waaay too slow!
|
||||
---------------------------------
|
||||
|
||||
Completion of complex libraries (like Numpy) should only be slow the first time
|
||||
you complete it. After that, the results should be cached and very fast.
|
||||
|
||||
If it's still slow, in case you've installed the python-mode VIM plugin, disable
|
||||
it. It seems to conflict with jedi-vim. See issue #163.
|
||||
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
|
||||
Reference in New Issue
Block a user