VimPlug/jedi-vim-fork
1
0
Fork 0
forked from VimPlug/jedi-vim
Code Pull Requests Activity

update README with new functions

Browse Source
This commit is contained in:
David Halter
2013-08-20 16:16:15 +04:30
parent 6ee05f976d
commit 9f683c4cbf
1 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.rst
View File

@@ -19,7 +19,7 @@ Display of function/class bodies, docstrings.
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png .. 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. 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 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`` and key defaults) which
initialized, if you don't want that: are automatically initialized, but you can change all of them:
.. code-block:: vim .. 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: ``goto_assignments`` is by default on ``<leader g>``:
.. code-block:: vim .. code-block:: vim
let g:jedi#goto_command = "<leader>g" let g:jedi#goto_assignments_command = "<leader>g"
``get_definition`` is by default on <leader d>. If you want to change that: ``goto_definitions`` is by default on ``<leader d>``:
.. code-block:: vim .. code-block:: vim
let g:jedi#get_definition_command = "<leader>d" let g:jedi#goto_definitions_command = "<leader>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 .. 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 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``:
@@ -117,21 +117,20 @@ There's some support for refactoring:
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 the usages of a name:
.. code-block:: vim .. code-block:: vim
let g:jedi#related_names_command = "<leader>n" let g:jedi#usages_command = "<leader>n"
If you want to change the default autocompletion command: If you want to change the default autocompletion command:
.. code-block:: vim .. code-block:: vim
let g:jedi#autocompletion_command = "<C-Space>" let g:jedi#completions_command = "<C-Space>"
By default you get a window that displays the function definition you're By default jedi-vim will display call signatures. If you don't want that:
currently in. If you don't want that:
.. code-block:: vim .. code-block:: vim
let g:jedi#show_function_definition = "0" let g:jedi#show_call_signatures = "0"