diff options
| author | Björn Linse <bjorn.linse@gmail.com> | 2021-12-31 20:10:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-31 20:10:35 +0100 |
| commit | b218d02c442ebacba1fdef0cca9e40315a46aedd (patch) | |
| tree | 0780d3d7eed40aff1e94347922dc7d5b0ca23107 /runtime | |
| parent | 5c1b8b77c59d06f80368784f0eac92d6a331a313 (diff) | |
| parent | b411f436d3e2e8a902dbf879d00fc5ed0fc436d3 (diff) | |
| download | rneovim-b218d02c442ebacba1fdef0cca9e40315a46aedd.tar.gz rneovim-b218d02c442ebacba1fdef0cca9e40315a46aedd.tar.bz2 rneovim-b218d02c442ebacba1fdef0cca9e40315a46aedd.zip | |
Merge pull request #16594 from shadmansaleh/feat/api/lua_keymaps
feat(api): add support for lua function & description in keymap
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index efffca72ad..e73634c632 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1580,8 +1580,11 @@ nvim_set_keymap({mode}, {lhs}, {rhs}, {*opts}) *nvim_set_keymap()* {rhs} Right-hand-side |{rhs}| of the mapping. {opts} Optional parameters map. Accepts all |:map-arguments| as keys excluding |<buffer>| but - including |noremap|. Values are Booleans. Unknown - key is an error. + 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. nvim_set_option({name}, {value}) *nvim_set_option()* Sets the global value of an option. |