mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 03:18:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): callback annotation for vim.ui.input #34507

Browse Source
This commit is contained in:
Maria José Solano
2025-06-17 06:37:27 -07:00
committed by GitHub
parent 006361fc6b
commit e74753a221
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/doc/lua.txt
View File

@@ -2606,10 +2606,10 @@ vim.ui.input({opts}, {on_confirm}) *vim.ui.input()*
"-complete=" argument. See |:command-completion| "-complete=" argument. See |:command-completion|
• highlight (function) Function that will be used for • highlight (function) Function that will be used for
highlighting user inputs. highlighting user inputs.
• {on_confirm} (`function`) ((input|nil) -> ()) Called once the user • {on_confirm} (`fun(input:string?)`) Called once the user confirms or
confirms or abort the input. `input` is what the user abort the input. `input` is what the user typed (it
typed (it might be an empty string if nothing was might be an empty string if nothing was entered), or
entered), or `nil` if the user aborted the dialog. `nil` if the user aborted the dialog.
vim.ui.open({path}, {opt}) *vim.ui.open()* vim.ui.open({path}, {opt}) *vim.ui.open()*
Opens `path` with the system default handler (macOS `open`, Windows Opens `path` with the system default handler (macOS `open`, Windows

2
runtime/lua/vim/ui.lua
View File

@@ -81,7 +81,7 @@ end
--- - highlight (function) --- - highlight (function)
--- Function that will be used for highlighting --- Function that will be used for highlighting
--- user inputs. --- user inputs.
---@param on_confirm function ((input|nil) -> ()) ---@param on_confirm fun(input:string|nil)
--- Called once the user confirms or abort the input. --- Called once the user confirms or abort the input.
--- `input` is what the user typed (it might be --- `input` is what the user typed (it might be
--- an empty string if nothing was entered), or --- an empty string if nothing was entered), or