docs(highlite): `resolve` function

This function had a glaring lack of documentation attached.
This commit is contained in:
Iron-E 2021-08-22 15:26:56 -04:00
parent 94eda96eb8
commit 671869d981
No known key found for this signature in database
GPG Key ID: 19B71B7B7B021D22
1 changed files with 5 additions and 1 deletions

View File

@ -167,7 +167,11 @@ function highlite:highlight_terminal(terminal_colors)
end
return setmetatable(highlite, {__call = function(self, normal, highlights, terminal_colors)
-- function to resolve function highlight groups being defined by function calls.
--- resolve highlight groups being defined by function calls.
--- @param tbl table the current table being indexed.
--- @param key string the key to resolve the value for.
--- @param resolve_links boolean whether to translate highlight links into full values
--- @returns the value at `tbl[key]`, when highlight links and embedded functions have been accounted for.
local function resolve(tbl, key, resolve_links)
local value = tbl[key]
local value_type = type(value)