diff options
| author | Mathias Fußenegger <mfussenegger@users.noreply.github.com> | 2023-07-13 14:43:36 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-13 14:43:36 +0200 |
| commit | a3f4598226c4d01e4fbc41181a1ad21793862fe3 (patch) | |
| tree | 01ca3fbc9b2fc288dcd2f8af96e3dda8145a4414 | |
| parent | 516b173780e39de3ce1e4525f0a8f0ff250c992b (diff) | |
| download | rneovim-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()`
| -rw-r--r-- | runtime/doc/lua.txt | 3 | ||||
| -rw-r--r-- | runtime/lua/vim/keymap.lua | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index ae3c248d64..3f5ab6e00f 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -2625,6 +2625,9 @@ set({mode}, {lhs}, {rhs}, {opts}) *vim.keymap.set()* See also: ~ • |nvim_set_keymap()| + • |maparg()| + • |mapcheck()| + • |mapset()| ============================================================================== 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' } }, |