aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/keymap.lua
diff options
context:
space:
mode:
authorMathias Fußenegger <mfussenegger@users.noreply.github.com>2023-07-13 14:43:36 +0200
committerGitHub <noreply@github.com>2023-07-13 14:43:36 +0200
commita3f4598226c4d01e4fbc41181a1ad21793862fe3 (patch)
tree01ca3fbc9b2fc288dcd2f8af96e3dda8145a4414 /runtime/lua/vim/keymap.lua
parent516b173780e39de3ce1e4525f0a8f0ff250c992b (diff)
downloadrneovim-a3f4598226c4d01e4fbc41181a1ad21793862fe3.tar.gz
rneovim-a3f4598226c4d01e4fbc41181a1ad21793862fe3.tar.bz2
rneovim-a3f4598226c4d01e4fbc41181a1ad21793862fe3.zip
docs(lua): adds links to related keymap functions to keymap.set (#24337)
Might help with discovery, given that there is no `keymap.get()`
Diffstat (limited to 'runtime/lua/vim/keymap.lua')
-rw-r--r--runtime/lua/vim/keymap.lua3
1 files changed, 3 insertions, 0 deletions
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index 9dbc65afe8..2b55ddc787 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -32,6 +32,9 @@ local keymap = {}
--- - "remap": (boolean) Make the mapping recursive. Inverse of "noremap".
--- Defaults to `false`.
---@see |nvim_set_keymap()|
+---@see |maparg()|
+---@see |mapcheck()|
+---@see |mapset()|
function keymap.set(mode, lhs, rhs, opts)
vim.validate({
mode = { mode, { 's', 't' } },