From 89208a798ed116c6c0d3611dc55d7e6d10aa2652 Mon Sep 17 00:00:00 2001 From: David Halter Date: Sat, 24 Aug 2013 20:22:21 +0430 Subject: [PATCH] shorten settings section --- README.rst | 51 ++++++++++++--------------------------------------- 1 file changed, 12 insertions(+), 39 deletions(-) diff --git a/README.rst b/README.rst index 4736477..cbc302b 100644 --- a/README.rst +++ b/README.rst @@ -79,8 +79,8 @@ On Arch Linux, you can also install jedi-vim from AUR: `vim-jedi `__. -Options -======= +Settings +======== Jedi is by default automatically initialized. If you don't want that I suggest you disable the auto-initialization in your ``.vimrc``: @@ -96,31 +96,14 @@ are automatically initialized, but you can change all of them: let g:jedi#auto_vim_configuration = 0 -``goto_assignments`` is by default on ````: - -.. code-block:: vim - - let g:jedi#goto_assignments_command = "g" - -``goto_definitions`` is by default on ````: - -.. code-block:: vim - - let g:jedi#goto_definitions_command = "d" - -Showing the pydoc documentation is by default on ``K``: - -.. code-block:: vim - - let g:jedi#documentation_command = "K" If you are a person who likes to use VIM-buffers not tabs, you might want to put that in your ``.vimrc``: - .. code-block:: vim let g:jedi#use_tabs_not_buffers = 0 + Jedi automatically starts the completion, if you type a dot, e.g. ``str.``, if you don't want this: @@ -128,36 +111,26 @@ you don't want this: let g:jedi#popup_on_dot = 0 -Jedi selects the first line of the completion menu: for a better typing-flow and -usually saves one keypress. +Jedi selects the first line of the completion menu: for a better typing-flow +and usually saves one keypress. .. code-block:: vim let g:jedi#popup_select_first = 0 -There's some support for refactoring: - -.. code-block:: vim - - let g:jedi#rename_command = "r" - -And you can list the usages of a name: +Here are a few more defaults for actions, read the docs (``:help jedi-vim``) to +get more information. You can change them .. code-block:: vim + let g:jedi#goto_assignments_command = "g" + let g:jedi#goto_definitions_command = "d" + let g:jedi#documentation_command = "K" let g:jedi#usages_command = "n" - -If you want to change the default autocompletion command: - -.. code-block:: vim - let g:jedi#completions_command = "" + let g:jedi#rename_command = "r" + let g:jedi#show_call_signatures = "1" -By default jedi-vim will display call signatures. If you don't want that: - -.. code-block:: vim - - let g:jedi#show_call_signatures = "0" Testing