forked from VimPlug/jedi-vim
Merge pull request #71 from ming13/readme-syntax-highlighting
Use VimL syntax highlighting in the readme file
This commit is contained in:
44
README.rst
44
README.rst
@@ -58,50 +58,72 @@ Options
|
||||
=======
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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"
|
||||
|
||||
``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"
|
||||
|
||||
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"
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
There's some support for refactoring::
|
||||
There's some support for refactoring:
|
||||
|
||||
.. code-block:: vim
|
||||
|
||||
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"
|
||||
|
||||
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>"
|
||||
|
||||
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"
|
||||
|
||||
Reference in New Issue
Block a user