doc: goto_stubs mapping <leader>s (#989)

Co-Authored-By: Daniel Hahler <github@thequod.de>
This commit is contained in:
Aleksandrs Stier
2020-01-24 20:11:02 +01:00
committed by Daniel Hahler
parent e8790b1d8f
commit c9bdefca54
2 changed files with 9 additions and 8 deletions

View File

@@ -58,9 +58,10 @@ generators, there is broad support.
Apart from that, jedi-vim supports the following commands Apart from that, jedi-vim supports the following commands
- Completion ``<C-Space>`` - Completion ``<C-Space>``
- Goto assignments ``<leader>g`` (typical goto function) - Goto assignment ``<leader>g`` (typical goto function)
- Goto definitions ``<leader>d`` (follow identifier as far as possible, - Goto definition ``<leader>d`` (follow identifier as far as possible,
includes imports and statements) includes imports and statements)
- Goto (typing) stub ``<leader>s``
- Show Documentation/Pydoc ``K`` (shows a popup with assignments) - Show Documentation/Pydoc ``K`` (shows a popup with assignments)
- Renaming ``<leader>r`` - Renaming ``<leader>r``
- Usages ``<leader>n`` (shows all the usages of a name) - Usages ``<leader>n`` (shows all the usages of a name)
@@ -198,6 +199,7 @@ get more information. If you set them to ``""``, they are not assigned.
let g:jedi#goto_command = "<leader>d" let g:jedi#goto_command = "<leader>d"
let g:jedi#goto_assignments_command = "<leader>g" let g:jedi#goto_assignments_command = "<leader>g"
let g:jedi#goto_stubs_command = "<leader>s"
let g:jedi#goto_definitions_command = "" let g:jedi#goto_definitions_command = ""
let g:jedi#documentation_command = "K" let g:jedi#documentation_command = "K"
let g:jedi#usages_command = "<leader>n" let g:jedi#usages_command = "<leader>n"

View File

@@ -24,7 +24,7 @@ Contents *jedi-vim-contents*
5.1. Start completion |g:jedi#completions_command| 5.1. Start completion |g:jedi#completions_command|
5.2. Go to definition |g:jedi#goto_command| 5.2. Go to definition |g:jedi#goto_command|
5.3. Go to assignment |g:jedi#goto_assignments_command| 5.3. Go to assignment |g:jedi#goto_assignments_command|
5.4 Go to definition (deprecated) |g:jedi#goto_definitions_command| 5.4 Go to stub |g:jedi#goto_stubs_command|
5.5. Show documentation |g:jedi#documentation_command| 5.5. Show documentation |g:jedi#documentation_command|
5.6. Rename variables |g:jedi#rename_command| 5.6. Rename variables |g:jedi#rename_command|
5.7. Show name usages |g:jedi#usages_command| 5.7. Show name usages |g:jedi#usages_command|
@@ -274,12 +274,11 @@ This function finds the first definition of the function/class under the
cursor. It produces an error if the definition is not in a Python file. cursor. It produces an error if the definition is not in a Python file.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
5.4. `g:jedi#goto_definitions_command` *g:jedi#goto_definitions_command* 5.4. `g:jedi#goto_stubs_command` *g:jedi#goto_stubs_command*
Function: `jedi#goto_definitions()` Function: `jedi#goto_stubs()`
Default: - Go to original definition Default: <leader>s Go to stub
NOTE: Deprecated. Use |g:jedi#goto_command| / |jedi#goto()| instead, which Finds the stub of the function/class under the cursor.
currently uses this internally.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
5.5. `g:jedi#documentation_command` *g:jedi#documentation_command* 5.5. `g:jedi#documentation_command` *g:jedi#documentation_command*