readme description of the new functions

This commit is contained in:
David Halter
2012-09-11 01:38:08 +02:00
parent 2ceba101df
commit 05cff2f27e

View File

@@ -149,14 +149,15 @@ have the following objects available:
VIM Plugin
-------------------
At the moment jedi is also a VIM plugin. Maybe that will change in the future.
The VIM plugin is located at `plugin/jedi.vim`.
At the moment jedi is also a VIM plugin. It is some sort of reference
implementation for other IDE's.
The VIM plugin is located under `plugin/jedi.vim`.
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.
Jedi is automatically initialized. If you don't want that, I suggest you
Jedi is automatically initialized. If you don't want that I suggest you
disable the auto-initialization in your `.vimrc`:
let g:jedi#auto_initialization = 0
@@ -165,11 +166,11 @@ 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).
The goto is by default on \<leader g\>. If you want to change that:
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:
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:
@@ -185,4 +186,12 @@ you don't want this:
let g:jedi#popup_on_dot = 0
There's some support for refactoring:
let g:jedi#rename_command = "<leader>r"
And you can list all names that are related (have the same origin):
let g:jedi#related_names_command = "<leader>n"
[![Build Status](https://secure.travis-ci.org/davidhalter/jedi.png?branch=master)](http://travis-ci.org/davidhalter/jedi)