diff options
| author | zeertzjq <zeertzjq@outlook.com> | 2022-02-16 16:58:32 +0800 |
|---|---|---|
| committer | zeertzjq <zeertzjq@outlook.com> | 2022-02-16 16:58:32 +0800 |
| commit | cc81a8253be032aa12f05730e8a2f1b5d94fd08c (patch) | |
| tree | b911ba8941773bbeecb1a85ebd17499e3a314024 | |
| parent | 9a74c2b04ac8f54a17925a437b5a2f03b18f6281 (diff) | |
| download | rneovim-cc81a8253be032aa12f05730e8a2f1b5d94fd08c.tar.gz rneovim-cc81a8253be032aa12f05730e8a2f1b5d94fd08c.tar.bz2 rneovim-cc81a8253be032aa12f05730e8a2f1b5d94fd08c.zip | |
docs: minor changes related to mapping description
| -rw-r--r-- | runtime/doc/api.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/map.txt | 4 | ||||
| -rw-r--r-- | src/nvim/api/vim.c | 2 |
3 files changed, 5 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 7a5aeee603..1e1534c31f 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1584,7 +1584,7 @@ nvim_set_keymap({mode}, {lhs}, {rhs}, {*opts}) *nvim_set_keymap()* {rhs} Right-hand-side |{rhs}| of the mapping. {opts} Optional parameters map. Accepts all |: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 Lua, also accepts a "callback" key that takes a Lua function to call when the mapping is executed. diff --git a/runtime/doc/map.txt b/runtime/doc/map.txt index 89df42600c..358e944261 100644 --- a/runtime/doc/map.txt +++ b/runtime/doc/map.txt @@ -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 |'<|. 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* When 'verbose' is non-zero, listing a key map will also display where it was diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index f4909b0801..565015cada 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -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 opts Optional parameters map. Accepts all |:map-arguments| /// 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 /// a Lua function to call when the mapping is executed. /// Values are Booleans. Unknown key is an error. |