aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/ui.lua
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/lua/vim/ui.lua')
-rw-r--r--runtime/lua/vim/ui.lua7
1 files changed, 4 insertions, 3 deletions
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index 8f5be15221..aaee175f3a 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -1,6 +1,7 @@
local M = {}
---- Prompts the user to pick a single item from a collection of entries
+--- Prompts the user to pick from a list of items, allowing arbitrary (potentially asynchronous)
+--- work until `on_choice`.
---
---@param items table Arbitrary items
---@param opts table Additional options
@@ -35,7 +36,6 @@ local M = {}
--- end
--- end)
--- </pre>
-
function M.select(items, opts, on_choice)
vim.validate({
items = { items, 'table', false },
@@ -55,7 +55,8 @@ function M.select(items, opts, on_choice)
end
end
---- Prompts the user for input
+--- Prompts the user for input, allowing arbitrary (potentially asynchronous) work until
+--- `on_confirm`.
---
---@param opts table Additional options. See |input()|
--- - prompt (string|nil)