aboutsummaryrefslogtreecommitdiff
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
parent52fe3741aa68e3175500b80bd0d5f85579c70712 (diff)
downloadrneovim-c2ddef30e743d8c1de6d960bf230b8646cb49c7c.tar.gz
rneovim-c2ddef30e743d8c1de6d960bf230b8646cb49c7c.tar.bz2
rneovim-c2ddef30e743d8c1de6d960bf230b8646cb49c7c.zip
docs: fix several misleading and superfluous wordings (#27609)
-rw-r--r--runtime/doc/api.txt19
-rw-r--r--runtime/lua/vim/_meta/api.lua19
-rw-r--r--src/nvim/api/extmark.c16
3 files changed, 17 insertions, 37 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]
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 998608ae16..aee866f324 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -584,21 +584,16 @@ function vim.api.nvim_buf_line_count(buffer) end
--- 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`.
@@ -1807,7 +1802,7 @@ function vim.api.nvim_set_current_win(window) end
--- • 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]
function vim.api.nvim_set_decoration_provider(ns_id, opts) end
diff --git a/src/nvim/api/extmark.c b/src/nvim/api/extmark.c
index 5dcda42b02..653140a7ae 100644
--- a/src/nvim/api/extmark.c
+++ b/src/nvim/api/extmark.c
@@ -467,25 +467,15 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
/// 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_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
/// - 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
/// - 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
/// - 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|.
@@ -1058,7 +1048,7 @@ void nvim_buf_clear_namespace(Buffer buffer, Integer ns_id, Integer line_start,
/// ["win", winid, bufnr, topline, botline]
/// - on_line: called for each buffer line being redrawn.
/// (The interaction with fold lines is subject to change)
-/// ["win", winid, bufnr, row]
+/// ["line", winid, bufnr, row]
/// - on_end: called at the end of a redraw cycle
/// ["end", tick]
void nvim_set_decoration_provider(Integer ns_id, Dict(set_decoration_provider) *opts, Error *err)