diff options
| author | luukvbaal <luukvbaal@gmail.com> | 2024-11-17 00:36:11 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-16 15:36:11 -0800 |
| commit | 9c718bc2bce53b5be45061bff940f99e50c8bfcb (patch) | |
| tree | 15449b558fa4de8d233036d2c624adb249dd82b4 /src/nvim/api/vim.c | |
| parent | f85bc41c800d7f5c0256f29aa347a53600a7c8d5 (diff) | |
| download | rneovim-9c718bc2bce53b5be45061bff940f99e50c8bfcb.tar.gz rneovim-9c718bc2bce53b5be45061bff940f99e50c8bfcb.tar.bz2 rneovim-9c718bc2bce53b5be45061bff940f99e50c8bfcb.zip | |
fix(api): validation, documentation of hl_group #31195
Problem: Documentation for "hl_group" in nvim_buf_set_extmark() is
unclear. "hl_group" in nvim_echo() does not accept
highlight group id.
Solution: Move documentation for highlight group name/id to first
mention of hl_group. Update nvim_echo() to accept highlight
group id.
Diffstat (limited to 'src/nvim/api/vim.c')
| -rw-r--r-- | src/nvim/api/vim.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 199b9a9690..89e974c098 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -779,8 +779,8 @@ void nvim_set_vvar(String name, Object value, Error *err) /// Echo a message. /// /// @param chunks A list of `[text, hl_group]` arrays, each representing a -/// text chunk with specified highlight. `hl_group` element -/// can be omitted for no highlight. +/// text chunk with specified highlight group name or ID. +/// `hl_group` element can be omitted for no highlight. /// @param history if true, add to |message-history|. /// @param opts Optional parameters. /// - verbose: Message is printed as a result of 'verbose' option. |