docs: fix several misleading and superfluous wordings (#27609)

This commit is contained in:
Evgeni Chasnovski
2024-02-25 02:45:34 +02:00
committed by GitHub
parent 52fe3741aa
commit c2ddef30e7
3 changed files with 17 additions and 37 deletions

View File

@@ -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