From 9f683c4cbf2b5865baf1c17f56daa038d7f84d8a Mon Sep 17 00:00:00 2001 From: David Halter Date: Tue, 20 Aug 2013 16:16:15 +0430 Subject: [PATCH] update README with new functions --- README.rst | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 58a1cbd..d30b370 100644 --- a/README.rst +++ b/README.rst @@ -19,7 +19,7 @@ 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). +Documentation (Pydoc) support (with highlighting, Shift+k). There is also support for goto and renaming. @@ -65,30 +65,30 @@ you disable the auto-initialization in your ``.vimrc``: let g:jedi#auto_initialization = 0 -There are also some VIM options (like ``completeopt``) which are automatically -initialized, if you don't want that: +There are also some VIM options (like ``completeopt`` and key defaults) which +are automatically initialized, but you can change all of them: .. code-block:: vim let g:jedi#auto_vim_configuration = 0 -The goto is by default on . If you want to change that: +``goto_assignments`` is by default on ````: .. code-block:: vim - let g:jedi#goto_command = "g" + let g:jedi#goto_assignments_command = "g" -``get_definition`` is by default on . If you want to change that: +``goto_definitions`` is by default on ````: .. code-block:: vim - let g:jedi#get_definition_command = "d" + let g:jedi#goto_definitions_command = "d" -Showing the pydoc is by default on ``K`` If you want to change that: +Showing the pydoc documentation is by default on ``K``: .. code-block:: vim - let g:jedi#pydoc = "K" + 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``: @@ -117,21 +117,20 @@ There's some support for refactoring: let g:jedi#rename_command = "r" -And you can list all names that are related (have the same origin): +And you can list the usages of a name: .. code-block:: vim - let g:jedi#related_names_command = "n" + let g:jedi#usages_command = "n" If you want to change the default autocompletion command: .. code-block:: vim - let g:jedi#autocompletion_command = "" + let g:jedi#completions_command = "" -By default you get a window that displays the function definition you're -currently in. If you don't want that: +By default jedi-vim will display call signatures. If you don't want that: .. code-block:: vim - let g:jedi#show_function_definition = "0" + let g:jedi#show_call_signatures = "0"