docs(highlight): fix type annotations (#22272)

This commit is contained in:
Jaehwang Jung 2023-03-05 01:47:30 +09:00 committed by GitHub
parent 46c4cbced5
commit 59542504b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -36,12 +36,12 @@ end
--- Highlight range between two positions --- Highlight range between two positions
--- ---
---@param bufnr number of buffer to apply highlighting to ---@param bufnr integer Buffer number to apply highlighting to
---@param ns namespace to add highlight to ---@param ns integer Namespace to add highlight to
---@param higroup highlight group to use for highlighting ---@param higroup string Highlight group to use for highlighting
---@param start first position (tuple {line,col}) ---@param start { [1]: integer, [2]: integer } Start position {line, col}
---@param finish second position (tuple {line,col}) ---@param finish { [1]: integer, [2]: integer } Finish position {line, col}
---@param opts table with options: ---@param opts table|nil Optional parameters
-- - regtype type of range (see |setreg()|, default charwise) -- - regtype type of range (see |setreg()|, default charwise)
-- - inclusive boolean indicating whether the range is end-inclusive (default false) -- - inclusive boolean indicating whether the range is end-inclusive (default false)
-- - priority number indicating priority of highlight (default priorities.user) -- - priority number indicating priority of highlight (default priorities.user)
@ -84,7 +84,7 @@ local yank_timer
--- customize conditions (here: do not highlight a visual selection) via --- customize conditions (here: do not highlight a visual selection) via
--- au TextYankPost * lua vim.highlight.on_yank {on_visual=false} --- au TextYankPost * lua vim.highlight.on_yank {on_visual=false}
--- ---
-- @param opts table with options controlling the highlight: -- @param opts table|nil Optional parameters
-- - higroup highlight group for yanked region (default "IncSearch") -- - higroup highlight group for yanked region (default "IncSearch")
-- - timeout time in ms before highlight is cleared (default 150) -- - timeout time in ms before highlight is cleared (default 150)
-- - on_macro highlight when executing macro (default false) -- - on_macro highlight when executing macro (default false)