mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-07 11:58:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor changes related to mapping description

Browse Source
This commit is contained in:
zeertzjq
2022-02-16 16:58:32 +08:00
parent 9a74c2b04a
commit cc81a8253b
3 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
runtime/doc/api.txt
View File

@@ -1584,7 +1584,7 @@ nvim_set_keymap({mode}, {lhs}, {rhs}, {*opts}) *nvim_set_keymap()*
{rhs} Right-hand-side |{rhs}| of the mapping. {rhs} Right-hand-side |{rhs}| of the mapping.
{opts} Optional parameters map. Accepts all {opts} Optional parameters map. Accepts all
|:map-arguments| as keys excluding |<buffer>| but |:map-arguments| as keys excluding |<buffer>| but
including |noremap| and "desc". |desc| can be used including |noremap| and "desc". "desc" can be used
to give a description to keymap. When called from to give a description to keymap. When called from
Lua, also accepts a "callback" key that takes a Lua, also accepts a "callback" key that takes a
Lua function to call when the mapping is executed. Lua function to call when the mapping is executed.

4
runtime/doc/map.txt
View File

@@ -502,7 +502,9 @@ Note: When using mappings for Visual mode, you can use the "'<" mark, which
is the start of the last selected Visual area in the current buffer |'<|. is the start of the last selected Visual area in the current buffer |'<|.
The |:filter| command can be used to select what mappings to list. The The |:filter| command can be used to select what mappings to list. The
pattern is matched against the {lhs}, {rhs} and {desc} in the raw form. pattern is matched against the {lhs} and {rhs} in the raw form. If a
description was added using |nvim_set_keymap()| or |nvim_buf_set_keymap()|
then the pattern is also matched against it.
*:map-verbose* *:map-verbose*
When 'verbose' is non-zero, listing a key map will also display where it was When 'verbose' is non-zero, listing a key map will also display where it was

2
src/nvim/api/vim.c
View File

@@ -1584,7 +1584,7 @@ ArrayOf(Dictionary) nvim_get_keymap(uint64_t channel_id, String mode)
/// @param rhs Right-hand-side |{rhs}| of the mapping. /// @param rhs Right-hand-side |{rhs}| of the mapping.
/// @param opts Optional parameters map. Accepts all |:map-arguments| /// @param opts Optional parameters map. Accepts all |:map-arguments|
/// as keys excluding |<buffer>| but including |noremap| and "desc". /// as keys excluding |<buffer>| but including |noremap| and "desc".
/// |desc| can be used to give a description to keymap. /// "desc" can be used to give a description to keymap.
/// When called from Lua, also accepts a "callback" key that takes /// When called from Lua, also accepts a "callback" key that takes
/// a Lua function to call when the mapping is executed. /// a Lua function to call when the mapping is executed.
/// Values are Booleans. Unknown key is an error. /// Values are Booleans. Unknown key is an error.