Skip to content

Commit e1a3aed

Browse files
marvimmarvim
committed
docs: regenerate [skip ci]
1 parent 61126fc commit e1a3aed

File tree

2 files changed

+46
-13
lines changed

2 files changed

+46
-13
lines changed

‎runtime/doc/api.txt

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -825,6 +825,7 @@ nvim_eval_statusline({str}, {*opts}) *nvim_eval_statusline()*
825825
• maxwidth: (number) Maximum width of statusline.
826826
• fillchar: (string) Character to fill blank
827827
spaces in the statusline (see 'fillchars').
828+
Treated as single-width even if it isn't.
828829
• highlights: (boolean) Return highlight
829830
information.
830831
• use_tabline: (boolean) Evaluate tabline instead
@@ -1546,19 +1547,25 @@ nvim_set_current_win({window}) *nvim_set_current_win()*
15461547
nvim_set_hl({ns_id}, {name}, {*val}) *nvim_set_hl()*
15471548
Sets a highlight group.
15481549

1550+
Note: Unlike the `:highlight` command which can update a highlight group, this function
1551+
completely replaces the definition. For example: nvim_set_hl(0, 'Visual , {}) will clear the highlight group 'Visual .
1552+
15491553
Parameters: ~
1550-
{ns_id} Namespace id for this highlight |nvim_create_namespace()|.
1551-
Use 0 to set a highlight group globally |:highlight|.
1554+
{ns_id} Namespace id for this highlight
1555+
|nvim_create_namespace()|. Use 0 to set a
1556+
highlight group globally |:highlight|.
15521557
{name} Highlight group name, e.g. "ErrorMsg"
15531558
{val} Highlight definition map, like |synIDattr()|. In
15541559
addition, the following keys are recognized:
1555-
• default: Don't override existing definition |:hi-default|
1556-
• ctermfg: Sets foreground of cterm color |highlight-ctermfg|
1557-
• ctermbg: Sets background of cterm color |highlight-ctermbg|
1560+
• default: Don't override existing definition
1561+
|:hi-default|
1562+
• ctermfg: Sets foreground of cterm color
1563+
|highlight-ctermfg|
1564+
• ctermbg: Sets background of cterm color
1565+
|highlight-ctermbg|
15581566
• cterm: cterm attribute map, like
1559-
|highlight-args|.
1560-
Note: Attributes default to those set for `gui`
1561-
if not set.
1567+
|highlight-args|. Note: Attributes default to
1568+
those set for `gui` if not set.
15621569

15631570
nvim_set_keymap({mode}, {lhs}, {rhs}, {*opts}) *nvim_set_keymap()*
15641571
Sets a global |mapping| for the given mode.
@@ -1932,7 +1939,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
19321939
• on_reload: Lua callback invoked on
19331940
reload. The entire buffer content should
19341941
be considered changed. Args:
1935-
• the string "detach"
1942+
• the string "reload"
19361943
• buffer handle
19371944

19381945
• utf_sizes: include UTF-32 and UTF-16 size
@@ -2577,6 +2584,28 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
25772584
not be placed if the line or column value is
25782585
past the end of the buffer or end of the line
25792586
respectively. Defaults to true.
2587+
• sign_text: string of length 1-2 used to
2588+
display in the sign column. Note: ranges are
2589+
unsupported and decorations are only applied
2590+
to start_row
2591+
• sign_hl_group: name of the highlight group
2592+
used to highlight the sign column text. Note:
2593+
ranges are unsupported and decorations are
2594+
only applied to start_row
2595+
• number_hl_group: name of the highlight group
2596+
used to highlight the number column. Note:
2597+
ranges are unsupported and decorations are
2598+
only applied to start_row
2599+
• line_hl_group: name of the highlight group
2600+
used to highlight the whole line. Note: ranges
2601+
are unsupported and decorations are only
2602+
applied to start_row
2603+
• cursorline_hl_group: name of the highlight
2604+
group used to highlight the line when the
2605+
cursor is on the same line as the mark and
2606+
'cursorline' is enabled. Note: ranges are
2607+
unsupported and decorations are only applied
2608+
to start_row
25802609

25812610
Return: ~
25822611
Id of the created/updated extmark
@@ -2811,7 +2840,7 @@ nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()*
28112840

28122841
nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()*
28132842
Sets the (1,0)-indexed cursor position in the window.
2814-
|api-indexing|
2843+
|api-indexing| Unlike |win_execute()| this scrolls the window.
28152844

28162845
Parameters: ~
28172846
{window} Window handle, or 0 for current window

‎runtime/doc/lua.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1259,6 +1259,10 @@ vim.wo *vim.wo*
12591259
==============================================================================
12601260
Lua module: vim *lua-vim*
12611261

1262+
*vim.connection_failure_errmsg()*
1263+
connection_failure_errmsg({consequence})
1264+
TODO: Documentation
1265+
12621266
defer_fn({fn}, {timeout}) *vim.defer_fn()*
12631267
Defers calling `fn` until `timeout` ms passes.
12641268

@@ -1990,9 +1994,9 @@ set({mode}, {lhs}, {rhs}, {opts}) *vim.keymap.set()*
19901994
vim.keymap.set('n', 'asdf', require('jkl').my_fun)
19911995
<
19921996

1993-
the require('jkl') gets evaluated during this call in order to
1994-
access the function. If you want to avoid this cost at startup
1995-
you can wrap it in a function, for example: >
1997+
the require('jkl )` gets evaluated during this call in order to access the
1998+
function. If you want to avoid this cost at startup you can
1999+
wrap it in a function, for example: >
19962000
19972001
vim.keymap.set('n', 'asdf', function() return require('jkl').my_fun() end)
19982002
<

0 commit comments

Comments
 (0)