IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14908 from neovim/marvim/api-doc-update/master

Browse Source 
docs: regenerate
This commit is contained in:
James McCoy 2021-07-08 22:50:18 -04:00 committed by GitHub
commit 27118c6eb3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
runtime/doc/api.txt
View File

@ -1104,7 +1104,7 @@ nvim_input_mouse({button}, {action}, {modifier}, {grid}, {row}, {col})
intermediate mouse positions will be ignored. It should be intermediate mouse positions will be ignored. It should be
used to implement real-time mouse input in a GUI. The used to implement real-time mouse input in a GUI. The
deprecated pseudokey form ("<LeftMouse><col,row>") of deprecated pseudokey form ("<LeftMouse><col,row>") of
|nvim_input()| has the same limitiation. |nvim_input()| has the same limitation.
Attributes: ~ Attributes: ~
{fast} {fast}
@ -1183,7 +1183,7 @@ nvim_notify({msg}, {log_level}, {opts}) *nvim_notify()*
Notify the user with a message Notify the user with a message
Relays the call to vim.notify . By default forwards your Relays the call to vim.notify . By default forwards your
message in the echo area but can be overriden to trigger message in the echo area but can be overridden to trigger
desktop notifications. desktop notifications.
Parameters: ~ Parameters: ~
@ -1197,7 +1197,7 @@ nvim_open_term({buffer}, {opts}) *nvim_open_term()*
By default (and currently the only option) the terminal will By default (and currently the only option) the terminal will
not be connected to an external process. Instead, input send not be connected to an external process. Instead, input send
on the channel will be echoed directly by the terminal. This on the channel will be echoed directly by the terminal. This
is useful to disply ANSI terminal sequences returned as part is useful to display ANSI terminal sequences returned as part
of a rpc message, or similar. of a rpc message, or similar.
Note: to directly initiate the terminal using the right size, Note: to directly initiate the terminal using the right size,
@ -1419,8 +1419,9 @@ nvim_parse_expression({expr}, {flags}, {highlight})
• "len": Amount of bytes successfully parsed. With flags • "len": Amount of bytes successfully parsed. With flags
equal to "" that should be equal to the length of expr equal to "" that should be equal to the length of expr
string. (“Sucessfully parsed” here means “participated string. (“Successfully parsed” here means
in AST creation”, not “till the first error”.) “participated in AST creation”, not “till the first
error”.)
• "ast": AST, either nil or a dictionary with these • "ast": AST, either nil or a dictionary with these
keys: keys:
• "type": node type, one of the value names from • "type": node type, one of the value names from
@ -1681,7 +1682,7 @@ nvim_set_decoration_provider({ns_id}, {opts})
Note: this function should not be called often. Rather, the Note: this function should not be called often. Rather, the
callbacks themselves can be used to throttle unneeded callbacks themselves can be used to throttle unneeded
callbacks. the `on_start` callback can return `false` to callbacks. the `on_start` callback can return `false` to
disable the provider until the next redraw. Similarily, return disable the provider until the next redraw. Similarly, return
`false` in `on_win` will skip the `on_lines` calls for that `false` in `on_win` will skip the `on_lines` calls for that
window (but any extmarks set in `on_win` will still be used). window (but any extmarks set in `on_win` will still be used).
A plugin managing multiple sources of decoration should A plugin managing multiple sources of decoration should
@ -1721,7 +1722,7 @@ nvim_set_hl({ns_id}, {name}, {val}) *nvim_set_hl()*
Parameters: ~ Parameters: ~
{ns_id} number of namespace for this highlight {ns_id} number of namespace for this highlight
{name} highlight group name, like ErrorMsg {name} highlight group name, like ErrorMsg
{val} highlight definiton map, like {val} highlight definition map, like
|nvim_get_hl_by_name|. in addition the following |nvim_get_hl_by_name|. in addition the following
keys are also recognized: `default` : don't keys are also recognized: `default` : don't
override existing definition, like `hi default` override existing definition, like `hi default`

16
runtime/doc/lsp.txt
View File

@ -1427,6 +1427,11 @@ reset({client_id}, {buffer_client_map}) *vim.lsp.diagnostic.reset()*
{buffer_client_map} table map of buffers to active {buffer_client_map} table map of buffers to active
clients clients
*vim.lsp.diagnostic.restore_extmarks()*
restore_extmarks({bufnr}, {last})
Parameters: ~
{last} number last line that was changed
save({diagnostics}, {bufnr}, {client_id}) *vim.lsp.diagnostic.save()* save({diagnostics}, {bufnr}, {client_id}) *vim.lsp.diagnostic.save()*
Save diagnostics to the current buffer. Save diagnostics to the current buffer.
@ -1438,6 +1443,10 @@ save({diagnostics}, {bufnr}, {client_id}) *vim.lsp.diagnostic.save()*
{bufnr} number {bufnr} number
{client_id} number {client_id} number
*vim.lsp.diagnostic.save_extmarks()*
save_extmarks({bufnr}, {client_id})
TODO: Documentation
set_loclist({opts}) *vim.lsp.diagnostic.set_loclist()* set_loclist({opts}) *vim.lsp.diagnostic.set_loclist()*
Sets the location list Sets the location list
@ -1632,7 +1641,9 @@ signature_help({_}, {method}, {result}, {_}, {bufnr}, {config})
• See |vim.api.nvim_open_win()| • See |vim.api.nvim_open_win()|
See also: ~ 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"> 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"
The active parameter is highlighted with
|hl-LspSignatureActiveParameter|>
vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with( vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(
vim.lsp.handlers.signature_help, { vim.lsp.handlers.signature_help, {
@ -1843,6 +1854,9 @@ get_lines({uri}, {rows}) *vim.lsp.util.get_lines()*
Return: ~ Return: ~
table<number string> a table mapping rows to lines table<number string> a table mapping rows to lines
get_markdown_fences() *vim.lsp.util.get_markdown_fences()*
TODO: Documentation
get_progress_messages() *vim.lsp.util.get_progress_messages()* get_progress_messages() *vim.lsp.util.get_progress_messages()*
TODO: Documentation TODO: Documentation