kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct on_key docs (#27429)

Browse Source
This commit is contained in:
altermo 2024-02-12 13:03:53 +01:00 committed by GitHub
parent 917172dd96
commit 6c168c0f4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
runtime/doc/lua.txt
View File

@ -1622,9 +1622,9 @@ vim.on_key({fn}, {ns_id}) *vim.on_key()*
• {fn} will receive the keys after mappings have been evaluated
Parameters: ~
• {fn} (`fun(key: string)`) Function invoked on every key press.
|i_CTRL-V| Returning nil removes the callback associated with
namespace {ns_id}.
• {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}.
• {ns_id} (`integer?`) Namespace ID. If nil or 0, generates and returns
a new |nvim_create_namespace()| id.

5
runtime/lua/vim/_editor.lua
View File

@ -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.
---