diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2022-12-14 19:58:18 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2023-02-22 16:23:49 +0100 |
| commit | 6752f1005d26c93a033d856a60b7b296f3e51634 (patch) | |
| tree | 5681d87457d1409b848947efc637dcc8eced2a81 /runtime/lua/vim/ui.lua | |
| parent | 0b36145c696fb58e002169edd4f9a1d9a8176fc3 (diff) | |
| download | rneovim-6752f1005d26c93a033d856a60b7b296f3e51634.tar.gz rneovim-6752f1005d26c93a033d856a60b7b296f3e51634.tar.bz2 rneovim-6752f1005d26c93a033d856a60b7b296f3e51634.zip | |
docs: naming conventions, guidelines
close #21063
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) |