Merge pull request #14107 from mfussenegger/gen-docs

Update lsp, lua and api docs (gen_vimdoc.py)
This commit is contained in:
Michael Lingelbach 2021-03-11 08:26:59 -08:00 committed by GitHub
commit 5d20fc4fc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 5 deletions

View File

@ -1415,8 +1415,8 @@ nvim_put({lines}, {type}, {after}, {follow}) *nvim_put()*
• "c" |charwise| mode
• "l" |linewise| mode
• "" guess by contents, see |setreg()|
{after} If true insert after cursor (like |p|), or before (like
|P|).
{after} If true insert after cursor (like |p|), or
before (like |P|).
{follow} If true place cursor at end of inserted text.
*nvim_replace_termcodes()*
@ -1737,7 +1737,7 @@ nvim__buf_stats({buffer}) *nvim__buf_stats()*
TODO: Documentation
*nvim_buf_add_highlight()*
nvim_buf_add_highlight({buffer}, {src_id}, {hl_group}, {line}, {col_start},
nvim_buf_add_highlight({buffer}, {ns_id}, {hl_group}, {line}, {col_start},
{col_end})
Adds a highlight to buffer.
@ -2202,6 +2202,19 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
column, without shifting the underlying
text.
• virt_text_hide : hide the virtual text when
the background text is selected or hidden due
to horizontal scroll 'nowrap'
• hl_mode : control how highlights are combined
with the highlights of the text. Currently
only affects virt_text highlights, but might
affect`hl_group`in later versions.
• "replace": only show the virt_text color.
This is the default
• "combine": combine with background text
color
• "blend": blend with background text color.
• ephemeral : for use with
|nvim_set_decoration_provider| callbacks. The
mark will only be used for the current redraw

View File

@ -1471,8 +1471,8 @@ show_line_diagnostics({opts}, {bufnr}, {line_nr}, {client_id})
==============================================================================
Lua module: vim.lsp.handlers *lsp-handlers*
*vim.lsp.handlers.progress_callback()*
progress_callback({_}, {_}, {params}, {client_id})
*vim.lsp.handlers.progress_handler()*
progress_handler({_}, {_}, {params}, {client_id})
See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_executeCommand
@ -1549,6 +1549,18 @@ close_preview_autocmd({events}, {winnr})
See also: ~
|autocmd-events|
*vim.lsp.util.compute_diff()*
compute_diff({old_lines}, {new_lines}, {start_line_idx}, {end_line_idx})
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
Return: ~
table start_line_idx and start_col_idx of range
*vim.lsp.util.convert_input_to_markdown_lines()*
convert_input_to_markdown_lines({input}, {contents})
Converts any of `MarkedString` | `MarkedString[]` |

View File

@ -1055,6 +1055,18 @@ list_extend({dst}, {src}, {start}, {finish}) *vim.list_extend()*
See also: ~
|vim.tbl_extend()|
list_slice({list}, {start}, {finish}) *vim.list_slice()*
Creates a copy of a table containing only elements from start
to end (inclusive)
Parameters: ~
{list} table table
{start} integer Start range of slice
{finish} integer End range of slice
Return: ~
Copy of table sliced from start to finish (inclusive)
pesc({s}) *vim.pesc()*
Escapes magic chars in a Lua pattern.