Skip to content

Commit

Permalink
docs: add priority option in buf_set_extmark
Browse files Browse the repository at this point in the history
  • Loading branch information
vigoux committed Apr 7, 2021
1 parent 91cdc11 commit d7a1bbd
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 3 deletions.
31 changes: 31 additions & 0 deletions runtime/doc/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1311,6 +1311,34 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
and clearing the |EndOfBuffer| region in
'winhighlight'.

`border`: style of (optional) window border. This can
either be a string or an array. the string
values are:
• "none" No border. This is the default
• "single" a single line box
• "double" a double line box
• "shadow" a drop shadow effect by blending
with the background. If it is an array it
should be an array of eight items or any
divisor of eight. The array will specifify
the eight chars building up the border in a
clockwise fashion starting with the top-left
corner. As, an example, the double box style
could be specified as: [ "╔", "═" ,"╗", "║",
"╝", "═", "╚", "║" ] if the number of chars
are less than eight, they will be repeated.
Thus an ASCII border could be specified as:
[ "/", "-", "\\", "|" ] or all chars the
same as: [ "x" ] An empty string can be used
to turn off a specific border, for instance:
[ "", "", "", ">", "", "", "", "<" ] will
only make vertical borders but not
horizontal ones. By default `FloatBorder`
highlight is used which links to `VertSplit`
when not defined. It could also be specified
by character: [ {"+", "MyCorner"}, {"x",
"MyBorder"} ]

Return: ~
Window handle, or 0 on error

Expand Down Expand Up @@ -2266,6 +2294,9 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
exists) will be shifted in when new text is
inserted (true for right, false for left).
Defaults to false.
• priority: a priority value for the highlight
group. For example treesitter highlighting
uses a value of 100.

Return: ~
Id of the created/updated extmark
Expand Down
32 changes: 29 additions & 3 deletions runtime/doc/lsp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1467,6 +1467,25 @@ progress_handler({_}, {_}, {params}, {client_id})
See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_executeCommand

*vim.lsp.handlers.signature_help()*
signature_help({_}, {method}, {result}, {_}, {bufnr}, {config})
Parameters: ~
{config} table Configuration table.
• border: (default=nil)
• Add borders to the floating window
• See |vim.api.nvim_open_win()|

See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_declaration@seehttps://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_definition@seehttps://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_typeDefinition@seehttps://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_implementation|lsp-handler| for the method "textDocument/signatureHelp">

vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(
vim.lsp.handlers.signature_help, {
-- Use a sharp border with `FloatBorder` highlights
border = "single"
}
)
<


==============================================================================
Lua module: vim.lsp.util *lsp-util*
Expand Down Expand Up @@ -1541,13 +1560,20 @@ close_preview_autocmd({events}, {winnr})
|autocmd-events|

*vim.lsp.util.compute_diff()*
compute_diff({old_lines}, {new_lines}, {start_line_idx}, {end_line_idx})
compute_diff({old_lines}, {new_lines}, {start_line_idx}, {end_line_idx},
{offset_encoding})
Returns the range table for the difference between old and new
lines

Parameters: ~
{old_lines} table list of lines
{new_lines} table list of lines
{old_lines} table list of lines
{new_lines} table list of lines
{start_line_idx} int line to begin search for first
difference
{end_line_idx} int line to begin search for last
difference
{offset_encoding} string encoding requested by language
server

Return: ~
table start_line_idx and start_col_idx of range
Expand Down
2 changes: 2 additions & 0 deletions src/nvim/api/buffer.c
Original file line number Diff line number Diff line change
Expand Up @@ -1449,6 +1449,8 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id,
/// the extmark end position (if it exists) will be shifted
/// in when new text is inserted (true for right, false
/// for left). Defaults to false.
/// - priority: a priority value for the highlight group. For
/// example treesitter highlighting uses a value of 100.
/// @param[out] err Error details, if any
/// @return Id of the created/updated extmark
Integer nvim_buf_set_extmark(Buffer buffer, Integer ns_id,
Expand Down

0 comments on commit d7a1bbd

Please sign in to comment.