kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-29 14:41:06 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: regenerate [skip ci]

Browse Source
This commit is contained in:
marvim 2022-03-20 18:00:30 +00:00
parent e7391191e2
commit 809dd65396
3 changed files with 53 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
runtime/doc/api.txt
View File

@ -826,6 +826,7 @@ nvim_eval_statusline({str}, {*opts}) *nvim_eval_statusline()*
• maxwidth: (number) Maximum width of statusline.
• fillchar: (string) Character to fill blank
spaces in the statusline (see 'fillchars').
Treated as single-width even if it isn't.
• highlights: (boolean) Return highlight
information.
• use_tabline: (boolean) Evaluate tabline instead
@ -1547,6 +1548,11 @@ nvim_set_current_win({window}) *nvim_set_current_win()*
nvim_set_hl({ns_id}, {name}, {*val}) *nvim_set_hl()*
Sets a highlight group.
Note: Unlike the `:highlight` command which can update a
highlight group, this function completely replaces the
definition. For example: `nvim_set_hl(0, 'Visual', {})` will
clear the highlight group 'Visual'.
Parameters: ~
{ns_id} Namespace id for this highlight
|nvim_create_namespace()|. Use 0 to set a
@ -1937,7 +1943,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
• on_reload: Lua callback invoked on
reload. The entire buffer content should
be considered changed. Args:
• the string "detach"
• the string "reload"
• buffer handle
• utf_sizes: include UTF-32 and UTF-16 size
@ -2582,6 +2588,35 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
not be 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_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
• 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
• 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
• 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
• 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|.
"hl_group" is used as highlight for the cchar
if provided, otherwise it defaults to
|hl-Conceal|.
Return: ~
Id of the created/updated extmark
@ -2816,7 +2851,8 @@ nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()*
nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()*
Sets the (1,0)-indexed cursor position in the window.
|api-indexing|
|api-indexing| This scrolls the window even if it is not the
current one.
Parameters: ~
{window} Window handle, or 0 for current window
@ -3001,9 +3037,10 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
">", "", "", "", "<" ] 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"} ].
which links to `WinSeparator` when not
defined. It could also be specified by
character: [ {"+", "MyCorner"}, {"x",
"MyBorder"} ].
• noautocmd: If true then no buffer-related
autocommand events such as |BufEnter|,

6
runtime/doc/lsp.txt
View File

@ -686,7 +686,11 @@ formatexpr({opts}) *vim.lsp.formatexpr()*
Provides an interface between the built-in client and a
`formatexpr` function.
Currently only supports a single client. This can be set via `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will typically or in `on_attach` via vim.api.nvim_buf_set_option(bufnr, 'formatexpr , 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})')`.
Currently only supports a single client. This can be set via
`setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will
typically or in `on_attach` via
`vim.api.nvim_buf_set_option(bufnr, 'formatexpr',
'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})')`.
Parameters: ~
{opts} table options for customizing the formatting

8
runtime/doc/lua.txt
View File

@ -1259,6 +1259,10 @@ vim.wo *vim.wo*
==============================================================================
Lua module: vim *lua-vim*
*vim.connection_failure_errmsg()*
connection_failure_errmsg({consequence})
TODO: Documentation
defer_fn({fn}, {timeout}) *vim.defer_fn()*
Defers calling `fn` until `timeout` ms passes.
@ -1550,7 +1554,7 @@ startswith({s}, {prefix}) *vim.startswith()*
tbl_add_reverse_lookup({o}) *vim.tbl_add_reverse_lookup()*
Add the reverse lookup values to an existing table. For
example: tbl_add_reverse_lookup { A = 1 } == { [1] = 'A , A = 1 }`
example: `tbl_add_reverse_lookup { A = 1 } == { [1] = 'A', A = 1 }`
Parameters: ~
{o} table The table to add the reverse to.
@ -1990,7 +1994,7 @@ set({mode}, {lhs}, {rhs}, {opts}) *vim.keymap.set()*
vim.keymap.set('n', 'asdf', require('jkl').my_fun)
<
the require('jkl )` gets evaluated during this call in order to access the
the `require('jkl')` gets evaluated during this call in order to access the
function. If you want to avoid this cost at startup you can
wrap it in a function, for example: >