commit a0d8c2b86e788ce4273f0b8df258cd9e8e432d38
parent 549c00c791d2574298d3c98ceb3e5ee40acc532f
Author: glepnir <glephunter@gmail.com>
Date: Mon, 16 Sep 2024 18:33:35 +0800
docs(eval): update param types of prompt-buffer functions (#30392)
Diffstat:
2 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
@@ -6703,7 +6703,7 @@ function vim.fn.printf(fmt, expr1) end
--- If the buffer doesn't exist or isn't a prompt buffer, an empty
--- string is returned.
---
---- @param buf any
+--- @param buf integer|string
--- @return any
function vim.fn.prompt_getprompt(buf) end
@@ -6738,8 +6738,8 @@ function vim.fn.prompt_getprompt(buf) end
--- endfunc
--- call prompt_setcallback(bufnr(), function('s:TextEntered'))
---
---- @param buf any
---- @param expr any
+--- @param buf integer|string
+--- @param expr string|function
--- @return any
function vim.fn.prompt_setcallback(buf, expr) end
@@ -6751,8 +6751,8 @@ function vim.fn.prompt_setcallback(buf, expr) end
--- mode. Without setting a callback Vim will exit Insert mode,
--- as in any buffer.
---
---- @param buf any
---- @param expr any
+--- @param buf integer|string
+--- @param expr string|function
--- @return any
function vim.fn.prompt_setinterrupt(buf, expr) end
@@ -6763,8 +6763,8 @@ function vim.fn.prompt_setinterrupt(buf, expr) end
--- call prompt_setprompt(bufnr(''), 'command: ')
--- <
---
---- @param buf any
---- @param text any
+--- @param buf integer|string
+--- @param text string
--- @return any
function vim.fn.prompt_setprompt(buf, text) end
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -8044,7 +8044,7 @@ M.funcs = {
]=],
name = 'prompt_getprompt',
- params = { { 'buf', 'any' } },
+ params = { { 'buf', 'integer|string' } },
signature = 'prompt_getprompt({buf})',
},
prompt_setcallback = {
@@ -8084,7 +8084,7 @@ M.funcs = {
]=],
name = 'prompt_setcallback',
- params = { { 'buf', 'any' }, { 'expr', 'any' } },
+ params = { { 'buf', 'integer|string' }, { 'expr', 'string|function' } },
signature = 'prompt_setcallback({buf}, {expr})',
},
prompt_setinterrupt = {
@@ -8101,7 +8101,7 @@ M.funcs = {
]=],
name = 'prompt_setinterrupt',
- params = { { 'buf', 'any' }, { 'expr', 'any' } },
+ params = { { 'buf', 'integer|string' }, { 'expr', 'string|function' } },
signature = 'prompt_setinterrupt({buf}, {expr})',
},
prompt_setprompt = {
@@ -8116,7 +8116,7 @@ M.funcs = {
<
]=],
name = 'prompt_setprompt',
- params = { { 'buf', 'any' }, { 'text', 'any' } },
+ params = { { 'buf', 'integer|string' }, { 'text', 'string' } },
signature = 'prompt_setprompt({buf}, {text})',
},
pum_getpos = {