kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-31 17:13:26 -07:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Evgeni Chasnovski 2024-02-25 02:45:34 +02:00 committed by GitHub
parent 52fe3741aa
commit c2ddef30e7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 17 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
runtime/doc/api.txt
View File

@ -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 placed if the line or column value is past the end of the
buffer or end of the line respectively. Defaults to true. buffer or end of the line respectively. Defaults to true.
• sign_text: string of length 1-2 used to display in the • sign_text: string of length 1-2 used to display in the
sign column. Note: ranges are unsupported and decorations sign column.
are only applied to start_row
• sign_hl_group: name of the highlight group used to • sign_hl_group: name of the highlight group used to
highlight the sign column text. Note: ranges are highlight the sign column text.
unsupported and decorations are only applied to start_row
• number_hl_group: name of the highlight group used to • number_hl_group: name of the highlight group used to
highlight the number column. Note: ranges are unsupported highlight the number column.
and decorations are only applied to start_row
• line_hl_group: name of the highlight group used to • line_hl_group: name of the highlight group used to
highlight the whole line. Note: ranges are unsupported and highlight the whole line.
decorations are only applied to start_row
• cursorline_hl_group: name of the highlight group used to • cursorline_hl_group: name of the highlight group used to
highlight the line when the cursor is on the same line as highlight the sign column text when the cursor is on the
the mark and 'cursorline' is enabled. Note: ranges are same line as the mark and 'cursorline' is enabled.
unsupported and decorations are only applied to start_row
• conceal: string which should be either empty or a single • conceal: string which should be either empty or a single
character. Enable concealing similar to |:syn-conceal|. character. Enable concealing similar to |:syn-conceal|.
When a character is supplied it is used as |:syn-cchar|. 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. • on_win: called when starting to redraw a specific window.
["win", winid, bufnr, topline, botline] ["win", winid, bufnr, topline, botline]
• on_line: called for each buffer line being redrawn. (The • 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] winid, bufnr, row]
• on_end: called at the end of a redraw cycle ["end", tick] • on_end: called at the end of a redraw cycle ["end", tick]

19
runtime/lua/vim/_meta/api.lua generated
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 --- placed if the line or column value is past the end of the
--- buffer or end of the line respectively. Defaults to true. --- buffer or end of the line respectively. Defaults to true.
--- • sign_text: string of length 1-2 used to display in the --- • sign_text: string of length 1-2 used to display in the
--- sign column. Note: ranges are unsupported and decorations --- sign column.
--- are only applied to start_row
--- • sign_hl_group: name of the highlight group used to --- • sign_hl_group: name of the highlight group used to
--- highlight the sign column text. Note: ranges are --- highlight the sign column text.
--- unsupported and decorations are only applied to start_row
--- • number_hl_group: name of the highlight group used to --- • number_hl_group: name of the highlight group used to
--- highlight the number column. Note: ranges are unsupported --- highlight the number column.
--- and decorations are only applied to start_row
--- • line_hl_group: name of the highlight group used to --- • line_hl_group: name of the highlight group used to
--- highlight the whole line. Note: ranges are unsupported and --- highlight the whole line.
--- decorations are only applied to start_row
--- • cursorline_hl_group: name of the highlight group used to --- • cursorline_hl_group: name of the highlight group used to
--- highlight the line when the cursor is on the same line as --- highlight the sign column text when the cursor is on the
--- the mark and 'cursorline' is enabled. Note: ranges are --- same line as the mark and 'cursorline' is enabled.
--- unsupported and decorations are only applied to start_row
--- • conceal: string which should be either empty or a single --- • conceal: string which should be either empty or a single
--- character. Enable concealing similar to `:syn-conceal`. --- character. Enable concealing similar to `:syn-conceal`.
--- When a character is supplied it is used as `:syn-cchar`. --- 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. --- • on_win: called when starting to redraw a specific window.
--- ["win", winid, bufnr, topline, botline] --- ["win", winid, bufnr, topline, botline]
--- • on_line: called for each buffer line being redrawn. (The --- • 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] --- winid, bufnr, row]
--- • on_end: called at the end of a redraw cycle ["end", tick] --- • on_end: called at the end of a redraw cycle ["end", tick]
function vim.api.nvim_set_decoration_provider(ns_id, opts) end function vim.api.nvim_set_decoration_provider(ns_id, opts) end

16
src/nvim/api/extmark.c
View File

@ -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. /// buffer or end of the line respectively. Defaults to true.
/// - sign_text: string of length 1-2 used to display in the /// - sign_text: string of length 1-2 used to display in the
/// sign column. /// sign column.
/// Note: ranges are unsupported and decorations are only
/// applied to start_row
/// - sign_hl_group: name of the highlight group used to /// - sign_hl_group: name of the highlight group used to
/// highlight the sign column text. /// 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 /// - number_hl_group: name of the highlight group used to
/// highlight the number column. /// 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 /// - line_hl_group: name of the highlight group used to
/// highlight the whole line. /// 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 /// - cursorline_hl_group: name of the highlight group used to
/// highlight the line when the cursor is on the same line /// highlight the sign column text when the cursor is on
/// as the mark and 'cursorline' is enabled. /// the same line as the mark and 'cursorline' is enabled.
/// Note: ranges are unsupported and decorations are only
/// applied to start_row
/// - conceal: string which should be either empty or a single /// - conceal: string which should be either empty or a single
/// character. Enable concealing similar to |:syn-conceal|. /// character. Enable concealing similar to |:syn-conceal|.
/// When a character is supplied it is used as |:syn-cchar|. /// 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] /// ["win", winid, bufnr, topline, botline]
/// - on_line: called for each buffer line being redrawn. /// - on_line: called for each buffer line being redrawn.
/// (The interaction with fold lines is subject to change) /// (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 /// - on_end: called at the end of a redraw cycle
/// ["end", tick] /// ["end", tick]
void nvim_set_decoration_provider(Integer ns_id, Dict(set_decoration_provider) *opts, Error *err) void nvim_set_decoration_provider(Integer ns_id, Dict(set_decoration_provider) *opts, Error *err)