aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authordundargoc <33953936+dundargoc@users.noreply.github.com>2022-05-15 10:44:48 +0200
committerGitHub <noreply@github.com>2022-05-15 16:44:48 +0800
commit0a66c4a72a9912f71cc8c3b1795ac2797dd5dbb9 (patch)
treeba8fd3e1fc3d1a22c92385dd2641ad94e0b84737 /runtime
parentbc45b5be1c2d13eb28eedc30f66e643cf25d29a0 (diff)
downloadrneovim-0a66c4a72a9912f71cc8c3b1795ac2797dd5dbb9.tar.gz
rneovim-0a66c4a72a9912f71cc8c3b1795ac2797dd5dbb9.tar.bz2
rneovim-0a66c4a72a9912f71cc8c3b1795ac2797dd5dbb9.zip
docs(nvim_set_keymap): specify that optional arguments defaults to false (#18177)
Closes: https://github.com/neovim/neovim/issues/16919
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 36325fb0ba..b5ec9114de 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1615,13 +1615,15 @@ nvim_set_keymap({mode}, {lhs}, {rhs}, {*opts}) *nvim_set_keymap()*
for |:map|.
{lhs} Left-hand-side |{lhs}| of the mapping.
{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
- 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.
+ {opts} Optional parameters map: keys are
+ |:map-arguments|, values are booleans (default
+ false). Accepts all |:map-arguments| as keys
+ excluding |<buffer>| but including |noremap| and
+ "desc". Unknown key is an error. "desc" can be
+ used to give a description to the mapping. When
+ called from Lua, also accepts a "callback" key
+ that takes a Lua function to call when the mapping
+ is executed.
nvim_set_option({name}, {value}) *nvim_set_option()*
Sets the global value of an option.