diff --git a/README.rst b/README.rst index 2a2cf16..5f1f121 100644 --- a/README.rst +++ b/README.rst @@ -68,28 +68,47 @@ Apart from that, jedi-vim supports the following commands Installation ============ +Requirements +------------ +You need a VIM version that was compiled with Python 2.6 or later +(``+python`` or ``+python3``), which is typical for most distributions on +Linux. You can check this from within VIM using +``:python3 import sys; print sys.version`` (use ``:python`` for Python 2). + +Manual installation +------------------- + You might want to use `pathogen `_ or -`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 Python version compiled into VIM must be 2.6 or later -(you can check this from within VIM using ``:python import sys; print sys.version`` ) +`Vundle `_ to install jedi-vim. 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`` -in your jedi-vim repository. +either install it via ``pip install jedi`` or with +``git submodule update --init`` in your jedi-vim repository. -Example Installation Command using Pathogen: +Example installation command using Pathogen: .. code-block:: sh cd ~/.vim/bundle/ && git clone --recursive https://github.com/davidhalter/jedi-vim.git -On Arch Linux, you can also install jedi-vim from official repositories as `vim-jedi -`__. It is also available -on `Debian (≥8) `__ and `Ubuntu (≥14.04) -`__ as vim-python-jedi. On Fedora Linux, -it is available as `vim-jedi `__. +Installation with your distribution +----------------------------------- + +On Arch Linux, you can also install jedi-vim from official repositories as +`vim-jedi `__. +It is also available on +`Debian (≥8) `__ and +`Ubuntu (≥14.04) `__ as +vim-python-jedi. +On Fedora Linux, it is available as +`vim-jedi `__. + +Please note that this version might be quite old compared to using jedi-vim +from Git. + +Caveats +------- Note that the `python-mode `_ VIM plugin seems to conflict with jedi-vim, therefore you should disable it before enabling diff --git a/jedi_vim.py b/jedi_vim.py index 9b0f0b7..037dd59 100644 --- a/jedi_vim.py +++ b/jedi_vim.py @@ -89,8 +89,8 @@ def no_jedi_warning(error=None): def echo_highlight(msg): - vim_command('echohl WarningMsg | echom "{0}" | echohl None'.format( - msg.replace('"', '\\"'))) + vim_command('echohl WarningMsg | echom "jedi-vim: {0}" | echohl None'.format( + str(msg).replace('"', '\\"'))) try: @@ -102,7 +102,10 @@ else: try: version = jedi.__version__ except Exception as e: # e.g. AttributeError - echo_highlight("Could not load jedi python module: {0}".format(e)) + echo_highlight( + "Error when loading the jedi python module ({0}). " + "Please ensure that Jedi is installed correctly (see Installation " + "in the README.".format(e)) jedi = None else: if isinstance(version, str):