commit 862e676efc7cbbaf1f6fe4901be6f97cb82a0e28
parent 5a2edc483dff93cc94847b6950713d80a51087c0
Author: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 3 May 2025 08:10:13 +0800
docs: add missing change to getcharstr() signature (#33797)
Diffstat:
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
@@ -3317,7 +3317,7 @@ getcharsearch() *getcharsearch()*
Return: ~
(`table`)
-getcharstr([{expr}]) *getcharstr()*
+getcharstr([{expr} [, {opts}]]) *getcharstr()*
The same as |getchar()|, except that this always returns a
String, and "number" isn't allowed in {opts}.
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -3730,7 +3730,7 @@ M.funcs = {
name = 'getcharstr',
params = { { 'expr', '-1|0|1' }, { 'opts', 'table' } },
returns = 'string',
- signature = 'getcharstr([{expr}])',
+ signature = 'getcharstr([{expr} [, {opts}]])',
},
getcmdcomplpat = {
desc = [=[