Cosmetic and formatting fixes

- Remove images in introduction
- Replace all occurences of VIM with Vim
- Use Vim code blocks
- Surround all keybindings with <>
This commit is contained in:
Patrice Peterson
2013-03-01 16:11:19 +01:00
parent e6ef96412e
commit 4bc8a44453

View File

@@ -6,7 +6,7 @@
| `--' | | |____ | '--' || | \ / | | | | | |~ | `--' | | |____ | '--' || | \ / | | | | | |~
\______/ |_______||_______/ |__| \__/ |__| |__| |__|~ \______/ |_______||_______/ |__| \__/ |__| |__| |__|~
jedi-vim - awesome Python autocompletion with VIM jedi-vim - awesome Python autocompletion with Vim
**now in beta testing phase** **now in beta testing phase**
============================================================================== ==============================================================================
@@ -24,43 +24,37 @@ CONTENTS *jedi-vim-contents*
============================================================================== ==============================================================================
1. Introduction *jedi-vim-introduction* 1. Introduction *jedi-vim-introduction*
jedi-vim is a is a VIM binding to the awesome autocompletion library *Jedi*. jedi-vim is a is a Vim binding to the awesome autocompletion library `Jedi`.
Here are some pictures:
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png
Completion for almost anything (Ctrl+Space).
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_function.png
Display of function/class bodies, docstrings.
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png
Pydoc support (with highlighting, Shift+k).
There is also support for goto and renaming.
- Completion for almost anything.
- Display of function/class bodies, docstrings.
- Pydoc support with highlighting.
- Support for goto and renaming.
============================================================================== ==============================================================================
2. Installation *jedi-vim-installation* 2. Installation *jedi-vim-installation*
Get the latest from `github <http://github.com/davidhalter/jedi-vim>`_. Get the latest from http://github.com/davidhalter/jedi-vim.
You can get the Jedi library `here <http://github.com/davidhalter/jedi>`_. You can get the Jedi library at http://github.com/davidhalter/jedi.
You might want to use `pathogen <https://github.com/tpope/vim-pathogen>`_ to You might want to use Pathogen http://github.com/tpope/vim-pathogen to
install jedi in Vim. Also you need a VIM version that was compiled with install Jedi in Vim. Also you need Vim compiled with +python, which is
``+python``, which is typical for most distributions on Linux. typical for most distributions on Linux.
The first thing you need after that is an up-to-date version of Jedi. You can 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`` either get it via >
pip install jedi
or with >
git submodule update --init
in your jedi-vim repository. in your jedi-vim repository.
On Arch Linux, you can also install jedi-vim from AUR: `vim-jedi On Arch Linux, you can also install jedi-vim from AUR, with the `vim-jedi`
<https://aur.archlinux.org/packages/vim-jedi/>`__. package.
============================================================================== ==============================================================================
3. Support *jedi-vim-support* 3. Support *jedi-vim-support*
@@ -71,8 +65,8 @@ generators, there is broad support.
============================================================================== ==============================================================================
4. Usage *jedi-vim-usage* 4. Usage *jedi-vim-usage*
The autocompletion can be used with <ctrl+space>, if you want it to work with The autocompletion can be used with <Ctrl-Space>, if you want it to work with
<tab> you can use `supertab <https://github.com/ervandew/supertab>`_. <Tab> you can use the Supertab plugin.
============================================================================== ==============================================================================
5. Mappings *jedi-vim-mappings* 5. Mappings *jedi-vim-mappings*
@@ -81,80 +75,56 @@ The autocompletion can be used with <ctrl+space>, if you want it to work with
6. Configuration *jedi-vim-configuration* 6. Configuration *jedi-vim-configuration*
Jedi is by default automatically initialized. If you don't want that I suggest Jedi is by default automatically initialized. If you don't want that I suggest
you disable the auto-initialization in your ``.vimrc``: you disable the auto-initialization in your .vimrc: >
.. code-block:: vim
let g:jedi#auto_initialization = 0 let g:jedi#auto_initialization = 0
There are also some VIM options (like ``completeopt``) which are automatically There are also some Vim options (like completeopt) which are automatically
initialized, if you don't want that: initialized, if you don't want that: >
.. code-block:: vim
let g:jedi#auto_vim_configuration = 0 let g:jedi#auto_vim_configuration = 0
The goto is by default on <leader g>. If you want to change that: The goto is by default on <leader-g>. If you want to change that: >
.. code-block:: vim
let g:jedi#goto_command = "<leader>g" let g:jedi#goto_command = "<leader>g"
``get_definition`` is by default on <leader d>. If you want to change that: get_definition is by default on <leader-d>. If you want to change that: >
.. code-block:: vim
let g:jedi#get_definition_command = "<leader>d" let g:jedi#get_definition_command = "<leader>d"
Showing the pydoc is by default on ``K`` If you want to change that: Showing the pydoc is by default on <K>. If you want to change that: >
.. code-block:: vim
let g:jedi#pydoc = "K" let g:jedi#pydoc = "K"
If you are a person who likes to use VIM-buffers not tabs, you might want to If you are a person who likes to use Vim buffers not tabs, you might want to
put that in your ``.vimrc``: put that in your .vimrc: >
.. code-block:: vim
let g:jedi#use_tabs_not_buffers = 0 let g:jedi#use_tabs_not_buffers = 0
Jedi automatically starts the completion, if you type a dot, e.g. ``str.``, if Jedi automatically starts the completion if you type a dot, e.g. "str.", if
you don't want this: you don't want this: >
.. code-block:: vim
let g:jedi#popup_on_dot = 0 let g:jedi#popup_on_dot = 0
Jedi selects the first line of the completion menu: for a better typing-flow and Jedi selects the first line of the completion menu: for a better typing-flow and
usually saves one keypress. usually saves one keypress. >
.. code-block:: vim
let g:jedi#popup_select_first = 0 let g:jedi#popup_select_first = 0
There's some support for refactoring: There's some support for refactoring: >
.. code-block:: vim
let g:jedi#rename_command = "<leader>r" let g:jedi#rename_command = "<leader>r"
And you can list all names that are related (have the same origin): And you can list all names that are related (have the same origin): >
.. code-block:: vim
let g:jedi#related_names_command = "<leader>n" let g:jedi#related_names_command = "<leader>n"
If you want to change the default autocompletion command: If you want to change the default autocompletion command: >
.. code-block:: vim let g:jedi#autocompletion_command = "<c-space>"
let g:jedi#autocompletion_command = "<C-Space>"
By default you get a window that displays the function definition you're By default you get a window that displays the function definition you're
currently in. If you don't want that: currently in. If you don't want that: >
.. code-block:: vim
let g:jedi#show_function_definition = "0" let g:jedi#show_function_definition = "0"