diff options
| author | Maria José Solano <majosolano99@gmail.com> | 2024-08-16 08:36:23 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-16 08:36:23 -0700 |
| commit | a901fb875f69ff4e3033f883d5b8665eb608a586 (patch) | |
| tree | 310fd7e926755e58bbb6bb0dee59529d9ff68733 | |
| parent | fd65422b99c7cc69e5053a852244cfc9d46d7b65 (diff) | |
| download | rneovim-a901fb875f69ff4e3033f883d5b8665eb608a586.tar.gz rneovim-a901fb875f69ff4e3033f883d5b8665eb608a586.tar.bz2 rneovim-a901fb875f69ff4e3033f883d5b8665eb608a586.zip | |
fix(docs): add missing properties to hl_info #30032
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 2 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/api_keysets_extra.lua | 15 | ||||
| -rwxr-xr-x | scripts/gen_eval_files.lua | 6 |
3 files changed, 16 insertions, 7 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 1b70cc275f..7dace2f88a 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -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 diff --git a/runtime/lua/vim/_meta/api_keysets_extra.lua b/runtime/lua/vim/_meta/api_keysets_extra.lua index e1f12868d0..6e95190692 100644 --- a/runtime/lua/vim/_meta/api_keysets_extra.lua +++ b/runtime/lua/vim/_meta/api_keysets_extra.lua @@ -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 diff --git a/scripts/gen_eval_files.lua b/scripts/gen_eval_files.lua index fc2fadc440..a5f9449049 100755 --- a/scripts/gen_eval_files.lua +++ b/scripts/gen_eval_files.lua @@ -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>', |