Skip to content

Commit 6de5142

Browse files
committed
docs(picker): document unified readable labels
1 parent 8b11cdc commit 6de5142

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,8 @@ default backend is `builtin`. To use an external picker, install the plugin and
272272
`picker.backend` to one of: `telescope`, `fzf-lua`, `snacks`.
273273
When using these external backends, the picker preview window shows the selected file
274274
content around the target location.
275+
Candidate labels are shown in a readable unified format:
276+
`<text> - <path>:<line>:<col>` (or `<path>:<line>:<col>` when text is empty).
275277

276278
```lua
277279
{

doc/peekstack.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,10 @@ Configure the backend with `picker.backend`:
155155

156156
For external backends (`telescope`, `fzf-lua`, `snacks`), picker preview windows
157157
show file content around the selected location.
158+
Picker labels use a unified readable format:
159+
<text> - <path>:<line>:<col>
160+
or, when text is empty:
161+
<path>:<line>:<col>
158162

159163
If the chosen plugin is not installed, a warning is shown and the picker will not open.
160164

0 commit comments

Comments
 (0)