commit 5ecbbba6ee4364dd2ad8ae4bebd0b004ae20deaf
parent db851cb105ac9f295a836a39ff73da14a70ae754
Author: atusy <30277794+atusy@users.noreply.github.com>
Date: Thu, 21 Apr 2022 10:15:19 +0900
docs: vim.keymap.set can specify buffer as an option
Diffstat:
2 files changed, 5 insertions(+), 0 deletions(-)
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
@@ -2055,6 +2055,9 @@ set({mode}, {lhs}, {rhs}, {opts}) *vim.keymap.set()*
"silent". In addition to the options listed in
|nvim_set_keymap()|, this table also accepts the
following keys:
+ • buffer: (number or boolean) Add a mapping to the
+ given buffer. When "true" or 0, use the current
+ buffer.
• replace_keycodes: (boolean, default true) When
both this and expr is "true",
|nvim_replace_termcodes()| is applied to the
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
@@ -40,6 +40,8 @@ local keymap = {}
--
---@param opts table A table of |:map-arguments| such as "silent". In addition to the options
--- listed in |nvim_set_keymap()|, this table also accepts the following keys:
+--- - buffer: (number or boolean) Add a mapping to the given buffer. When "true"
+--- or 0, use the current buffer.
--- - replace_keycodes: (boolean, default true) When both this and expr is "true",
--- |nvim_replace_termcodes()| is applied to the result of Lua expr maps.
--- - remap: (boolean) Make the mapping recursive. This is the