From 671869d981c47ccb2f7370145062a9cd9967d17b Mon Sep 17 00:00:00 2001 From: Iron-E Date: Sun, 22 Aug 2021 15:26:56 -0400 Subject: [PATCH] docs(highlite): `resolve` function This function had a glaring lack of documentation attached. --- lua/highlite.lua | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lua/highlite.lua b/lua/highlite.lua index 692a0ca..95c2108 100644 --- a/lua/highlite.lua +++ b/lua/highlite.lua @@ -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)