diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-02-22 10:40:01 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-22 10:40:01 -0500 |
| commit | 09b6a68c3700aa5d8ae26a62896b091572ae0a8d (patch) | |
| tree | f3dff4f44ec8867e775565172203988f317d59ad /runtime/lua/vim/ui.lua | |
| parent | 675826da63e879efa97c0998fea192ed5c79d56e (diff) | |
| parent | 6752f1005d26c93a033d856a60b7b296f3e51634 (diff) | |
| download | rneovim-09b6a68c3700aa5d8ae26a62896b091572ae0a8d.tar.gz rneovim-09b6a68c3700aa5d8ae26a62896b091572ae0a8d.tar.bz2 rneovim-09b6a68c3700aa5d8ae26a62896b091572ae0a8d.zip | |
Merge #21428 docs: naming conventions, guidelines
Diffstat (limited to 'runtime/lua/vim/ui.lua')
| -rw-r--r-- | runtime/lua/vim/ui.lua | 7 |
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) |