fix(docs): add missing properties to hl_info #30032

This commit is contained in:
Maria José Solano 2024-08-16 08:36:23 -07:00 committed by GitHub
parent fd65422b99
commit a901fb875f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 16 additions and 7 deletions

View File

@ -1321,7 +1321,7 @@ function vim.api.nvim_get_current_win() end
--- of effective definition `:hi-link`.
--- • create: (boolean, default true) When highlight group doesn't
--- exist create it.
--- @return vim.api.keyset.hl_info
--- @return vim.api.keyset.get_hl_info
function vim.api.nvim_get_hl(ns_id, opts) end
--- @deprecated

View File

@ -96,20 +96,29 @@ error('Cannot require a meta file')
--- @field strikethrough? true
--- @field altfont? true
--- @field nocombine? true
--- @class vim.api.keyset.hl_info.cterm : vim.api.keyset.hl_info.base
--- @field ctermfg? integer
--- @field ctermbg? integer
--- @class vim.api.keyset.hl_info.cterm : vim.api.keyset.hl_info.base
--- @field foreground? integer
--- @field background? integer
--- @class vim.api.keyset.hl_info : vim.api.keyset.hl_info.base
--- @class vim.api.keyset.get_hl_info : vim.api.keyset.hl_info.base
--- @field fg? integer
--- @field bg? integer
--- @field sp? integer
--- @field default? true
--- @field blend? integer
--- @field cterm? vim.api.keyset.hl_info.cterm
--- @class vim.api.keyset.set_hl_info : vim.api.keyset.hl_info.base
--- @field fg? integer|string
--- @field bg? integer|string
--- @field sp? integer|string
--- @field default? true
--- @field link? string
--- @field blend? integer
--- @field force? true
--- @field cterm? vim.api.keyset.hl_info.cterm
--- @class vim.api.keyset.get_mode

View File

@ -29,11 +29,11 @@ local LUA_API_RETURN_OVERRIDES = {
nvim_get_keymap = 'vim.api.keyset.keymap[]',
nvim_get_mark = 'vim.api.keyset.get_mark',
-- Can also return table<string,vim.api.keyset.hl_info>, however we need to
-- Can also return table<string,vim.api.keyset.get_hl_info>, however we need to
-- pick one to get some benefit.
-- REVISIT lewrus01 (26/01/24): we can maybe add
-- @overload fun(ns: integer, {}): table<string,vim.api.keyset.hl_info>
nvim_get_hl = 'vim.api.keyset.hl_info',
-- @overload fun(ns: integer, {}): table<string,vim.api.keyset.get_hl_info>
nvim_get_hl = 'vim.api.keyset.get_hl_info',
nvim_get_mode = 'vim.api.keyset.get_mode',
nvim_get_namespaces = 'table<string,integer>',