Skip to content

Commit e50cf9d

Browse files
committed
docs(pick): add usage example to ui_select()
1 parent 5c72e4d commit e50cf9d

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

doc/mini-pick.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,6 +1047,10 @@ Implements the required by `vim.ui.select()` signature. Plus allows extra
10471047
Notes:
10481048
- `on_choice` is called when target window is current.
10491049

1050+
Usage ~
1051+
>lua
1052+
vim.ui.select = MiniPick.ui_select
1053+
<
10501054
------------------------------------------------------------------------------
10511055
*MiniPick.builtin*
10521056
`MiniPick.builtin`

lua/mini/pick.lua

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,6 +1224,10 @@ end
12241224
---
12251225
--- Notes:
12261226
--- - `on_choice` is called when target window is current.
1227+
---
1228+
---@usage >lua
1229+
--- vim.ui.select = MiniPick.ui_select
1230+
--- <
12271231
MiniPick.ui_select = function(items, opts, on_choice)
12281232
local format_item = opts.format_item or H.item_to_string
12291233
local items_ext = {}

0 commit comments

Comments
 (0)