aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
diff options
context:
space:
mode:
authorEvgeni Chasnovski <evgeni.chasnovski@gmail.com>2024-02-25 02:45:34 +0200
committerGitHub <noreply@github.com>2024-02-25 08:45:34 +0800
commitc2ddef30e743d8c1de6d960bf230b8646cb49c7c (patch)
tree66cfa62e0abe7baa02384bf769222068336d899f /runtime/doc/api.txt
parent52fe3741aa68e3175500b80bd0d5f85579c70712 (diff)
downloadrneovim-c2ddef30e743d8c1de6d960bf230b8646cb49c7c.tar.gz
rneovim-c2ddef30e743d8c1de6d960bf230b8646cb49c7c.tar.bz2
rneovim-c2ddef30e743d8c1de6d960bf230b8646cb49c7c.zip
docs: fix several misleading and superfluous wordings (#27609)
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r--runtime/doc/api.txt19
1 files changed, 7 insertions, 12 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 821d2eb748..e994644be9 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -2762,21 +2762,16 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
placed if the line or column value is past the end of the
buffer or end of the line respectively. Defaults to true.
• sign_text: string of length 1-2 used to display in the
- sign column. Note: ranges are unsupported and decorations
- are only applied to start_row
+ sign column.
• sign_hl_group: name of the highlight group used to
- highlight the sign column text. Note: ranges are
- unsupported and decorations are only applied to start_row
+ highlight the sign column text.
• number_hl_group: name of the highlight group used to
- highlight the number column. Note: ranges are unsupported
- and decorations are only applied to start_row
+ highlight the number column.
• line_hl_group: name of the highlight group used to
- highlight the whole line. Note: ranges are unsupported and
- decorations are only applied to start_row
+ highlight the whole line.
• cursorline_hl_group: name of the highlight group used to
- highlight the line when the cursor is on the same line as
- the mark and 'cursorline' is enabled. Note: ranges are
- unsupported and decorations are only applied to start_row
+ highlight the sign column text when the cursor is on the
+ same line as the mark and 'cursorline' is enabled.
• conceal: string which should be either empty or a single
character. Enable concealing similar to |:syn-conceal|.
When a character is supplied it is used as |:syn-cchar|.
@@ -2863,7 +2858,7 @@ nvim_set_decoration_provider({ns_id}, {*opts})
• on_win: called when starting to redraw a specific window.
["win", winid, bufnr, topline, botline]
• on_line: called for each buffer line being redrawn. (The
- interaction with fold lines is subject to change) ["win",
+ interaction with fold lines is subject to change) ["line",
winid, bufnr, row]
• on_end: called at the end of a redraw cycle ["end", tick]