chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2024-06-07 06:52:39 +00:00
parent e879302d00
commit 7d512d5fb4
2 changed files with 17 additions and 3 deletions

View File

@ -155,7 +155,7 @@ local defaults = {
}, },
-- Key mappings can be set to the name of a builtin action, -- Key mappings can be set to the name of a builtin action,
-- or you can define your own custom action. -- or you can define your own custom action.
---@type table<string, string|trouble.Action> ---@type table<string, trouble.Action.spec>
keys = { keys = {
["?"] = "help", ["?"] = "help",
r = "refresh", r = "refresh",
@ -175,6 +175,8 @@ local defaults = {
-- k = "prev", -- k = "prev",
["{"] = "prev", ["{"] = "prev",
["[["] = "prev", ["[["] = "prev",
dd = "delete",
d = { action = "delete", mode = "v" },
i = "inspect", i = "inspect",
p = "preview", p = "preview",
P = "toggle_preview", P = "toggle_preview",
@ -420,6 +422,11 @@ require("trouble").statusline(opts)
---@return trouble.View ---@return trouble.View
require("trouble").cancel(opts) require("trouble").cancel(opts)
-- Open the preview
---@param opts? trouble.Mode | { new? : boolean } | string
---@return trouble.View
require("trouble").delete(opts)
-- filter -- filter
---@param opts? trouble.Mode | { new? : boolean } | string ---@param opts? trouble.Mode | { new? : boolean } | string
---@return trouble.View ---@return trouble.View

View File

@ -1,4 +1,4 @@
*trouble.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 June 06 *trouble.nvim.txt* For Neovim >= 0.8.0 Last change: 2024 June 07
============================================================================== ==============================================================================
Table of Contents *trouble.nvim-table-of-contents* Table of Contents *trouble.nvim-table-of-contents*
@ -175,7 +175,7 @@ Default Settings ~
}, },
-- Key mappings can be set to the name of a builtin action, -- Key mappings can be set to the name of a builtin action,
-- or you can define your own custom action. -- or you can define your own custom action.
---@type table<string, string|trouble.Action> ---@type table<string, trouble.Action.spec>
keys = { keys = {
["?"] = "help", ["?"] = "help",
r = "refresh", r = "refresh",
@ -195,6 +195,8 @@ Default Settings ~
-- k = "prev", -- k = "prev",
["{"] = "prev", ["{"] = "prev",
["[["] = "prev", ["[["] = "prev",
dd = "delete",
d = { action = "delete", mode = "v" },
i = "inspect", i = "inspect",
p = "preview", p = "preview",
P = "toggle_preview", P = "toggle_preview",
@ -434,6 +436,11 @@ API ~
---@return trouble.View ---@return trouble.View
require("trouble").cancel(opts) require("trouble").cancel(opts)
-- Open the preview
---@param opts? trouble.Mode | { new? : boolean } | string
---@return trouble.View
require("trouble").delete(opts)
-- filter -- filter
---@param opts? trouble.Mode | { new? : boolean } | string ---@param opts? trouble.Mode | { new? : boolean } | string
---@return trouble.View ---@return trouble.View