diff options
| author | altermo <107814000+altermo@users.noreply.github.com> | 2024-02-12 13:03:53 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-12 20:03:53 +0800 |
| commit | 6c168c0f4d777d7586b47a05d2539210ce711f1c (patch) | |
| tree | 0d7a1051a6440a5804b4834ff7cce0c66cef1da1 /runtime/lua/vim/_editor.lua | |
| parent | 917172dd9680cc4234a47beee91e8adcaf0e833c (diff) | |
| download | rneovim-6c168c0f4d777d7586b47a05d2539210ce711f1c.tar.gz rneovim-6c168c0f4d777d7586b47a05d2539210ce711f1c.tar.bz2 rneovim-6c168c0f4d777d7586b47a05d2539210ce711f1c.zip | |
docs: correct on_key docs (#27429)
Diffstat (limited to 'runtime/lua/vim/_editor.lua')
| -rw-r--r-- | runtime/lua/vim/_editor.lua | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua index c130eb1958..c5a6e65e86 100644 --- a/runtime/lua/vim/_editor.lua +++ b/runtime/lua/vim/_editor.lua @@ -652,8 +652,9 @@ local on_key_cbs = {} ---@note {fn} will not be cleared by |nvim_buf_clear_namespace()| ---@note {fn} will receive the keys after mappings have been evaluated --- ----@param fn fun(key: string) Function invoked on every key press. |i_CTRL-V| ---- Returning nil removes the callback associated with namespace {ns_id}. +---@param fn fun(key: string)? Function invoked on every key press. |i_CTRL-V| +--- Passing in nil when {ns_id} is specified removes the +--- callback associated with namespace {ns_id}. ---@param ns_id integer? Namespace ID. If nil or 0, generates and returns a --- new |nvim_create_namespace()| id. --- |