mirror of
https://github.com/neovim/neovim.git
synced 2025-09-28 22:18:33 +00:00
docs: misc, help tags for neovim.io searches #31428
Problem: Various keywords are commonly searched-for on https://neovim.io, but don't have help tags. Solution: Add help tags. fix #31327
This commit is contained in:
@@ -1040,7 +1040,7 @@ fail:
|
||||
/// Open a terminal instance in a buffer
|
||||
///
|
||||
/// By default (and currently the only option) the terminal will not be
|
||||
/// connected to an external process. Instead, input send on the channel
|
||||
/// connected to an external process. Instead, input sent on the channel
|
||||
/// will be echoed directly by the terminal. This is useful to display
|
||||
/// ANSI terminal sequences returned as part of a rpc message, or similar.
|
||||
///
|
||||
@@ -1051,6 +1051,18 @@ fail:
|
||||
/// Then |nvim_chan_send()| can be called immediately to process sequences
|
||||
/// in a virtual terminal having the intended size.
|
||||
///
|
||||
/// Example: this `TermHl` command can be used to display and highlight raw ANSI termcodes, so you
|
||||
/// can use Nvim as a "scrollback pager" (for terminals like kitty): [terminal-scrollback-pager]()
|
||||
///
|
||||
/// ```lua
|
||||
/// vim.api.nvim_create_user_command('TermHl', function()
|
||||
/// local b = vim.api.nvim_create_buf(false, true)
|
||||
/// local chan = vim.api.nvim_open_term(b, {})
|
||||
/// vim.api.nvim_chan_send(chan, table.concat(vim.api.nvim_buf_get_lines(0, 0, -1, false), '\n'))
|
||||
/// vim.api.nvim_win_set_buf(0, b)
|
||||
/// end, { desc = 'Highlights ANSI termcodes in curbuf' })
|
||||
/// ```
|
||||
///
|
||||
/// @param buffer the buffer to use (expected to be empty)
|
||||
/// @param opts Optional parameters.
|
||||
/// - on_input: Lua callback for input sent, i e keypresses in terminal
|
||||
|
@@ -6049,6 +6049,7 @@ M.funcs = {
|
||||
]=],
|
||||
name = 'jobwait',
|
||||
params = { { 'jobs', 'integer[]' }, { 'timeout', 'integer' } },
|
||||
returns = 'integer[]',
|
||||
signature = 'jobwait({jobs} [, {timeout}])',
|
||||
},
|
||||
join = {
|
||||
@@ -8776,7 +8777,7 @@ M.funcs = {
|
||||
<
|
||||
]=],
|
||||
name = 'rpcnotify',
|
||||
params = { { 'channel', 'integer' }, { 'event', 'string' }, { 'args', 'any' } },
|
||||
params = { { 'channel', 'integer' }, { 'event', 'string' }, { '...', 'any' } },
|
||||
signature = 'rpcnotify({channel}, {event} [, {args}...])',
|
||||
},
|
||||
rpcrequest = {
|
||||
@@ -8789,7 +8790,7 @@ M.funcs = {
|
||||
<
|
||||
]=],
|
||||
name = 'rpcrequest',
|
||||
params = { { 'channel', 'integer' }, { 'method', 'string' }, { 'args', 'any' } },
|
||||
params = { { 'channel', 'integer' }, { 'method', 'string' }, { '...', 'any' } },
|
||||
signature = 'rpcrequest({channel}, {method} [, {args}...])',
|
||||
},
|
||||
rpcstart = {
|
||||
@@ -11155,7 +11156,7 @@ M.funcs = {
|
||||
and exists only for backwards-compatibility.
|
||||
With UTF-8 composing characters are handled properly: >vim
|
||||
echo str2list("á") " returns [97, 769]
|
||||
|
||||
<
|
||||
]=],
|
||||
name = 'str2list',
|
||||
params = { { 'string', 'string' }, { 'utf8', 'boolean' } },
|
||||
@@ -13091,6 +13092,7 @@ M.funcs = {
|
||||
]=],
|
||||
name = 'winlayout',
|
||||
params = { { 'tabnr', 'integer' } },
|
||||
returns = 'any[]',
|
||||
signature = 'winlayout([{tabnr}])',
|
||||
},
|
||||
winline = {
|
||||
|
Reference in New Issue
Block a user