diff options
| author | zeertzjq <zeertzjq@outlook.com> | 2023-06-12 20:08:08 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-12 20:08:08 +0800 |
| commit | 0eb02ea90a5a7c2e35bfcf99b701a28ff2901b4b (patch) | |
| tree | 7735f3708831104414789f645870baebe08e0662 /runtime/lua/vim/keymap.lua | |
| parent | 758c418d1261fd69c4a85aa5cfa6a0d1dcdf66a4 (diff) | |
| download | rneovim-0eb02ea90a5a7c2e35bfcf99b701a28ff2901b4b.tar.gz rneovim-0eb02ea90a5a7c2e35bfcf99b701a28ff2901b4b.tar.bz2 rneovim-0eb02ea90a5a7c2e35bfcf99b701a28ff2901b4b.zip | |
docs: various clarifications (#23999)
Close #18907
Close #20314
Close #23749
Diffstat (limited to 'runtime/lua/vim/keymap.lua')
| -rw-r--r-- | runtime/lua/vim/keymap.lua | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua index 0d7fc3b1ec..9dbc65afe8 100644 --- a/runtime/lua/vim/keymap.lua +++ b/runtime/lua/vim/keymap.lua @@ -27,9 +27,9 @@ local keymap = {} --- - "replace_keycodes" defaults to `true` if "expr" is `true`. --- - "noremap": inverse of "remap" (see below). --- - Also accepts: ---- - "buffer" number|boolean Creates buffer-local mapping, `0` or `true` +--- - "buffer": (number|boolean) Creates buffer-local mapping, `0` or `true` --- for current buffer. ---- - remap: (boolean) Make the mapping recursive. Inverses "noremap". +--- - "remap": (boolean) Make the mapping recursive. Inverse of "noremap". --- Defaults to `false`. ---@see |nvim_set_keymap()| function keymap.set(mode, lhs, rhs, opts) @@ -83,8 +83,8 @@ end --- vim.keymap.del({'n', 'i', 'v'}, '<leader>w', { buffer = 5 }) --- </pre> ---@param opts table|nil A table of optional arguments: ---- - buffer: (number or boolean) Remove a mapping from the given buffer. ---- When "true" or 0, use the current buffer. +--- - "buffer": (number|boolean) Remove a mapping from the given buffer. +--- When `0` or `true`, use the current buffer. ---@see |vim.keymap.set()| --- function keymap.del(modes, lhs, opts) |