From c9bdefca547d8d9fc1add1231d1f7d381d056ebf Mon Sep 17 00:00:00 2001 From: Aleksandrs Stier <36510152+astier@users.noreply.github.com> Date: Fri, 24 Jan 2020 20:11:02 +0100 Subject: [PATCH] doc: goto_stubs mapping s (#989) Co-Authored-By: Daniel Hahler --- README.rst | 6 ++++-- doc/jedi-vim.txt | 11 +++++------ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index bb16b4aa..95800dfe 100644 --- a/README.rst +++ b/README.rst @@ -58,9 +58,10 @@ generators, there is broad support. Apart from that, jedi-vim supports the following commands - Completion ```` -- Goto assignments ``g`` (typical goto function) -- Goto definitions ``d`` (follow identifier as far as possible, +- Goto assignment ``g`` (typical goto function) +- Goto definition ``d`` (follow identifier as far as possible, includes imports and statements) +- Goto (typing) stub ``s`` - Show Documentation/Pydoc ``K`` (shows a popup with assignments) - Renaming ``r`` - Usages ``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 = "d" let g:jedi#goto_assignments_command = "g" + let g:jedi#goto_stubs_command = "s" let g:jedi#goto_definitions_command = "" let g:jedi#documentation_command = "K" let g:jedi#usages_command = "n" diff --git a/doc/jedi-vim.txt b/doc/jedi-vim.txt index c70a969a..26d12b96 100644 --- a/doc/jedi-vim.txt +++ b/doc/jedi-vim.txt @@ -24,7 +24,7 @@ Contents *jedi-vim-contents* 5.1. Start completion |g:jedi#completions_command| 5.2. Go to definition |g:jedi#goto_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.6. Rename variables |g:jedi#rename_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. ------------------------------------------------------------------------------ -5.4. `g:jedi#goto_definitions_command` *g:jedi#goto_definitions_command* -Function: `jedi#goto_definitions()` -Default: - Go to original definition +5.4. `g:jedi#goto_stubs_command` *g:jedi#goto_stubs_command* +Function: `jedi#goto_stubs()` +Default: s Go to stub -NOTE: Deprecated. Use |g:jedi#goto_command| / |jedi#goto()| instead, which -currently uses this internally. +Finds the stub of the function/class under the cursor. ------------------------------------------------------------------------------ 5.5. `g:jedi#documentation_command` *g:jedi#documentation_command*