mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
fix(gen_vimdoc.py): spacing around inline elements #16092
The spacing fix drew attention to a couple of places that were using incorrect formatting such as the key listing for `nvim_open_win`, so those were fixed too.
This commit is contained in:
Gregory Anders
GitHub
@@ -1877,7 +1877,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
|
||||
callbacks.
|
||||
{opts} Optional parameters.
|
||||
• on_lines: Lua callback invoked on change.
|
||||
Return`true`to detach. Args:
|
||||
Return `true` to detach. Args:
|
||||
• the string "lines"
|
||||
• buffer handle
|
||||
• b:changedtick
|
||||
@@ -1893,7 +1893,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
|
||||
• on_bytes: lua callback invoked on change.
|
||||
This callback receives more granular
|
||||
information about the change compared to
|
||||
on_lines. Return`true`to detach. Args:
|
||||
on_lines. Return `true` to detach. Args:
|
||||
• the string "bytes"
|
||||
• buffer handle
|
||||
• b:changedtick
|
||||
@@ -2332,7 +2332,7 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
|
||||
• 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.
|
||||
affect `hl_group` in later versions.
|
||||
• "replace": only show the virt_text color.
|
||||
This is the default
|
||||
• "combine": combine with background text
|
||||
@@ -2742,28 +2742,29 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
|
||||
{buffer} Buffer to display, or 0 for current buffer
|
||||
{enter} Enter the window (make it the current window)
|
||||
{config} Map defining the window configuration. Keys:
|
||||
• `relative`: Sets the window layout to "floating", placed
|
||||
at (row,col) coordinates relative to:
|
||||
• relative: Sets the window layout to
|
||||
"floating", placed at (row,col) coordinates
|
||||
relative to:
|
||||
• "editor" The global editor grid
|
||||
• "win" Window given by the `win` field, or
|
||||
current window.
|
||||
• "cursor" Cursor position in current window.
|
||||
|
||||
• `win` : |window-ID| for relative="win".
|
||||
• `anchor`: Decides which corner of the float to place
|
||||
at (row,col):
|
||||
• win: |window-ID| for relative="win".
|
||||
• anchor: Decides which corner of the float to
|
||||
place at (row,col):
|
||||
• "NW" northwest (default)
|
||||
• "NE" northeast
|
||||
• "SW" southwest
|
||||
• "SE" southeast
|
||||
|
||||
• `width` : Window width (in character cells).
|
||||
• width: Window width (in character cells).
|
||||
Minimum of 1.
|
||||
• `height` : Window height (in character cells).
|
||||
• height: Window height (in character cells).
|
||||
Minimum of 1.
|
||||
• `bufpos`: Places float relative to buffer text (only
|
||||
when relative="win"). Takes a tuple of
|
||||
zero-indexed [line, column].`row`and`col`if given are applied relative to this
|
||||
• bufpos: Places float relative to buffer text
|
||||
(only when relative="win"). Takes a tuple of
|
||||
zero-indexed [line, column]. `row` and `col` if given are applied relative to this
|
||||
position, else they default to:
|
||||
• `row=1` and `col=0` if `anchor` is "NW" or
|
||||
"NE"
|
||||
@@ -2771,19 +2772,19 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
|
||||
"SE" (thus like a tooltip near the buffer
|
||||
text).
|
||||
|
||||
• `row` : Row position in units of "screen cell
|
||||
• row: Row position in units of "screen cell
|
||||
height", may be fractional.
|
||||
• `col` : Column position in units of "screen
|
||||
cell width", may be fractional.
|
||||
• `focusable` : Enable focus by user actions
|
||||
• col: Column position in units of "screen cell
|
||||
width", may be fractional.
|
||||
• focusable: Enable focus by user actions
|
||||
(wincmds, mouse events). Defaults to true.
|
||||
Non-focusable windows can be entered by
|
||||
|nvim_set_current_win()|.
|
||||
• `external` : GUI should display the window as
|
||||
an external top-level window. Currently
|
||||
accepts no other positioning configuration
|
||||
together with this.
|
||||
• `zindex`: Stacking order. floats with higher`zindex`go on top on floats with lower indices. Must
|
||||
• external: GUI should display the window as an
|
||||
external top-level window. Currently accepts
|
||||
no other positioning configuration together
|
||||
with this.
|
||||
• zindex: Stacking order. floats with higher `zindex` go on top on floats with lower indices. Must
|
||||
be larger than zero. The following screen
|
||||
elements have hard-coded z-indices:
|
||||
• 100: insert completion popupmenu
|
||||
@@ -2794,7 +2795,7 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
|
||||
are recommended, unless there is a good
|
||||
reason to overshadow builtin elements.
|
||||
|
||||
• `style`: Configure the appearance of the window.
|
||||
• style: Configure the appearance of the window.
|
||||
Currently only takes one non-empty value:
|
||||
• "minimal" Nvim will display the window with
|
||||
many UI options disabled. This is useful
|
||||
@@ -2809,9 +2810,9 @@ 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
|
||||
• border: Style of (optional) window border.
|
||||
This can either be a string or an array. The
|
||||
string values are
|
||||
• "none": No border (default).
|
||||
• "single": A single line box.
|
||||
• "double": A double line box.
|
||||
@@ -2841,7 +2842,7 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
|
||||
It could also be specified by character: [
|
||||
{"+", "MyCorner"}, {"x", "MyBorder"} ].
|
||||
|
||||
• `noautocmd` : If true then no buffer-related
|
||||
• noautocmd: If true then no buffer-related
|
||||
autocommand events such as |BufEnter|,
|
||||
|BufLeave| or |BufWinEnter| may fire from
|
||||
calling this function.
|
||||
|
||||
@@ -670,7 +670,7 @@ omnifunc({findstart}, {base}) *vim.lsp.omnifunc()*
|
||||
{base} If findstart=0, text to match against
|
||||
|
||||
Return: ~
|
||||
(number) Decided by`findstart`:
|
||||
(number) Decided by {findstart}:
|
||||
• findstart=0: column where the completion starts, or -2
|
||||
or -3
|
||||
• findstart=1: list of matches (actually just calls
|
||||
|
||||
@@ -1518,7 +1518,7 @@ tbl_flatten({t}) *vim.tbl_flatten()*
|
||||
Flattened copy of the given list-like table.
|
||||
|
||||
See also: ~
|
||||
Fromhttps://github.com/premake/premake-core/blob/master/src/base/table.lua
|
||||
From https://github.com/premake/premake-core/blob/master/src/base/table.lua
|
||||
|
||||
tbl_isempty({t}) *vim.tbl_isempty()*
|
||||
Checks if a table is empty.
|
||||
@@ -1554,7 +1554,7 @@ tbl_keys({t}) *vim.tbl_keys()*
|
||||
list of keys
|
||||
|
||||
See also: ~
|
||||
Fromhttps://github.com/premake/premake-core/blob/master/src/base/table.lua
|
||||
From https://github.com/premake/premake-core/blob/master/src/base/table.lua
|
||||
|
||||
tbl_map({func}, {t}) *vim.tbl_map()*
|
||||
Apply a function to all values of a table.
|
||||
|
||||
@@ -1430,7 +1430,7 @@ end
|
||||
---@param findstart 0 or 1, decides behavior
|
||||
---@param base If findstart=0, text to match against
|
||||
---
|
||||
---@returns (number) Decided by `findstart`:
|
||||
---@returns (number) Decided by {findstart}:
|
||||
--- - findstart=0: column where the completion starts, or -2 or -3
|
||||
--- - findstart=1: list of matches (actually just calls |complete()|)
|
||||
function lsp.omnifunc(findstart, base)
|
||||
|
||||
Reference in New Issue
Block a user