aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2024-10-12 08:07:05 +0800
committerGitHub <noreply@github.com>2024-10-12 08:07:05 +0800
commit0e42c81c7fd429529d89458349c7cdde254d5406 (patch)
tree4504e1e7382f27d80aaf5914d61c3bdf729ee456 /runtime/doc
parentc49030b75ad8b8a9f8e7f023b0ee5f9c8c40afdd (diff)
downloadrneovim-0e42c81c7fd429529d89458349c7cdde254d5406.tar.gz
rneovim-0e42c81c7fd429529d89458349c7cdde254d5406.tar.bz2
rneovim-0e42c81c7fd429529d89458349c7cdde254d5406.zip
fix(lua): avoid recursive vim.on_key() callback (#30753)
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lua.txt2
-rw-r--r--runtime/doc/news.txt3
2 files changed, 5 insertions, 0 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 3e8d8bb62c..4acf8dc0af 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -1678,6 +1678,8 @@ vim.on_key({fn}, {ns_id}) *vim.on_key()*
Note: ~
• {fn} will be removed on error.
+ • {fn} won't be invoked recursively, i.e. if {fn} itself consumes input,
+ it won't be invoked for those keys.
• {fn} will not be cleared by |nvim_buf_clear_namespace()|
Parameters: ~
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index 1b311330b0..6af136bb5a 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -262,6 +262,9 @@ These existing features changed their behavior.
more emoji characters than before, including those encoded with multiple
emoji codepoints combined with ZWJ (zero width joiner) codepoints.
+• |vim.on_key()| callbacks won't be invoked recursively when a callback itself
+ consumes input.
+
==============================================================================
REMOVED FEATURES *news-removed*