mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove mention of foreground/background/special keys in nvim_set_hl (#27558)

Browse Source 
To align the output of `nvim_get_hl` with its documentation -- which
points to `nvim_set_hl`, remove mentions of the keys `foreground`,
`background` and `special`.

The long keys are are still supported (via fallback checks inside
`dict2hlattrs`), but the `fg`, `bg` and `sp` keys are preferenced.
This commit is contained in:
rktjmp
2024-02-22 00:25:08 +11:00
committed by GitHub
parent ac0e8323dc
commit 6d8bbfe19d
3 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
runtime/doc/api.txt
View File

@@ -1473,9 +1473,9 @@ nvim_set_hl({ns_id}, {name}, {*val}) *nvim_set_hl()*
activate them.
• {name} Highlight group name, e.g. "ErrorMsg"
• {val} Highlight definition map, accepts the following keys:
• fg (or foreground): color name or "#RRGGBB", see note.
• bg (or background): color name or "#RRGGBB", see note.
• sp (or special): color name or "#RRGGBB"
• fg: color name or "#RRGGBB", see note.
• bg: color name or "#RRGGBB", see note.
• sp: color name or "#RRGGBB"
• blend: integer between 0 and 100
• bold: boolean
• standout: boolean

6
runtime/lua/vim/_meta/api.lua generated
View File

@@ -1819,9 +1819,9 @@ function vim.api.nvim_set_decoration_provider(ns_id, opts) end
--- activate them.
--- @param name string Highlight group name, e.g. "ErrorMsg"
--- @param val vim.api.keyset.highlight Highlight definition map, accepts the following keys:
--- • fg (or foreground): color name or "#RRGGBB", see note.
--- • bg (or background): color name or "#RRGGBB", see note.
--- • sp (or special): color name or "#RRGGBB"
--- • fg: color name or "#RRGGBB", see note.
--- • bg: color name or "#RRGGBB", see note.
--- • sp: color name or "#RRGGBB"
--- • blend: integer between 0 and 100
--- • bold: boolean
--- • standout: boolean

6
src/nvim/api/vim.c
View File

@@ -141,9 +141,9 @@ Dictionary nvim_get_hl(Integer ns_id, Dict(get_highlight) *opts, Arena *arena, E
/// |nvim_set_hl_ns()| or |nvim_win_set_hl_ns()| to activate them.
/// @param name Highlight group name, e.g. "ErrorMsg"
/// @param val Highlight definition map, accepts the following keys:
/// - fg (or foreground): color name or "#RRGGBB", see note.
/// - bg (or background): color name or "#RRGGBB", see note.
/// - sp (or special): color name or "#RRGGBB"
/// - fg: color name or "#RRGGBB", see note.
/// - bg: color name or "#RRGGBB", see note.
/// - sp: color name or "#RRGGBB"
/// - blend: integer between 0 and 100
/// - bold: boolean
/// - standout: boolean