From 506659a00195dcba7c7931a442e32044493b084b Mon Sep 17 00:00:00 2001 From: folke <292349+folke@users.noreply.github.com> Date: Tue, 4 Feb 2025 16:25:42 +0000 Subject: [PATCH] chore(build): auto-generate docs --- docs/health.md | 2 +- docs/picker.md | 38 +++++++++++++++++++------------------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/health.md b/docs/health.md index 33cb54de..1861ec56 100644 --- a/docs/health.md +++ b/docs/health.md @@ -7,7 +7,7 @@ ```lua ---@class snacks.health.Tool ---@field cmd string|string[] ----@field version? string +---@field version? string|false ---@field enabled? boolean ``` diff --git a/docs/picker.md b/docs/picker.md index 67f52875..100fd238 100644 --- a/docs/picker.md +++ b/docs/picker.md @@ -552,6 +552,23 @@ Snacks.picker.pick({source = "files", ...}) ---@field cmd? snacks.picker.EditCmd ``` +```lua +---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} +``` + +```lua +---@class snacks.picker.Last +---@field cursor number +---@field topline number +---@field opts? snacks.picker.Config +---@field selected snacks.picker.Item[] +---@field filter snacks.picker.Filter +``` + +```lua +---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} +``` + ```lua ---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} ---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string} @@ -628,23 +645,6 @@ It's a previewer that shows a preview based on the item data. ---@field preview? snacks.win.Config|{} preview window config ``` -```lua ----@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} -``` - -```lua ----@class snacks.picker.Last ----@field cursor number ----@field topline number ----@field opts? snacks.picker.Config ----@field selected snacks.picker.Item[] ----@field filter snacks.picker.Filter -``` - -```lua ----@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} -``` - ## 📦 Module ```lua @@ -2461,8 +2461,6 @@ Snacks.picker.actions.toggle_preview(picker) Snacks.picker.actions.yank(_, item) ``` - - ## 📦 `snacks.picker.core.picker` ```lua @@ -2696,3 +2694,5 @@ Get the word under the cursor or the current visual selection ```lua picker:word() ``` + +