docs: update type annotations & default config opts in README.md

aileot · Jan 12, 2024 · fb52c97 · fb52c97
1 parent 0b27192
commit fb52c97
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -281,10 +281,7 @@ a transparent background color for a specific character.
    require('deadcolumn').setup({
        blending = {
            colorcode = '#1F2430',
-           hlgroup = {
-               'NonText',
-               'background',
-           },
+           hlgroup = { 'NonText', 'bg' },
        },
    })
    ```

diff --git a/doc/deadcolumn.nvim.txt b/doc/deadcolumn.nvim.txt
@@ -313,10 +313,7 @@ Workarounds:
    require('deadcolumn').setup({
        blending = {
            colorcode = '#1F2430',
-           hlgroup = {
-               'NonText',
-               'background',
-           },
+           hlgroup = { 'NonText', 'bg' },
        },
    })
 <

diff --git a/lua/deadcolumn.lua b/lua/deadcolumn.lua
@@ -5,7 +5,7 @@ local C_NORMAL, C_CC, C_ERROR
 
 ---Get background color in hex
 ---@param hlgroup_name string
----@param field string 'foreground' or 'background'
+---@param field 'fg'|'bg'
 ---@param fallback string|nil fallback color in hex, default to '#000000' if &bg is 'dark' and '#FFFFFF' if &bg is 'light'
 ---@return string hex color
 local function get_hl_hex(hlgroup_name, field, fallback)