From 6d8bbfe19df2175637a1e47ac1aafb0e96e35b38 Mon Sep 17 00:00:00 2001 From: rktjmp Date: Thu, 22 Feb 2024 00:25:08 +1100 Subject: docs: remove mention of foreground/background/special keys in nvim_set_hl (#27558) 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. --- runtime/doc/api.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'runtime/doc') diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 503529dd01..c6e706d6c5 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -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 -- cgit