kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 03:05:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: standardize doc for ChanInfo/ChanOpen autocmds/v:event (#31099)

Browse Source
This commit is contained in:
errael 2024-11-15 17:37:36 -08:00 committed by GitHub
parent 2eb227f5b6
commit 2f7b0018b0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/doc/autocmd.txt
View File

@ -353,15 +353,11 @@ BufWritePost After writing the whole buffer to a file
ChanInfo State of channel changed, for instance the ChanInfo State of channel changed, for instance the
client of a RPC channel described itself. client of a RPC channel described itself.
Sets these |v:event| keys: Sets these |v:event| keys:
info info as from |nvim_get_chan_info()|
See |nvim_get_chan_info()| for the format of
the info Dictionary.
*ChanOpen* *ChanOpen*
ChanOpen Just after a channel was opened. ChanOpen Just after a channel was opened.
Sets these |v:event| keys: Sets these |v:event| keys:
info info as from |nvim_get_chan_info()|
See |nvim_get_chan_info()| for the format of
the info Dictionary.
*CmdUndefined* *CmdUndefined*
CmdUndefined When a user command is used but it isn't CmdUndefined When a user command is used but it isn't
defined. Useful for defining a command only defined. Useful for defining a command only

1
runtime/doc/vvars.txt
View File

@ -152,6 +152,7 @@ v:event
an aborting condition (e.g. |c_Esc| or an aborting condition (e.g. |c_Esc| or
|c_CTRL-C| for |CmdlineLeave|). |c_CTRL-C| for |CmdlineLeave|).
chan |channel-id| chan |channel-id|
info Dict of arbitrary event data.
cmdlevel Level of cmdline. cmdlevel Level of cmdline.
cmdtype Type of cmdline, |cmdline-char|. cmdtype Type of cmdline, |cmdline-char|.
cwd Current working directory. cwd Current working directory.

1
runtime/lua/vim/_meta/vvars.lua generated
View File

@ -160,6 +160,7 @@ vim.v.errors = ...
--- an aborting condition (e.g. `c_Esc` or --- an aborting condition (e.g. `c_Esc` or
--- `c_CTRL-C` for `CmdlineLeave`). --- `c_CTRL-C` for `CmdlineLeave`).
--- chan `channel-id` --- chan `channel-id`
--- info Dict of arbitrary event data.
--- cmdlevel Level of cmdline. --- cmdlevel Level of cmdline.
--- cmdtype Type of cmdline, `cmdline-char`. --- cmdtype Type of cmdline, `cmdline-char`.
--- cwd Current working directory. --- cwd Current working directory.

1
src/nvim/vvars.lua
View File

@ -171,6 +171,7 @@ M.vars = {
an aborting condition (e.g. |c_Esc| or an aborting condition (e.g. |c_Esc| or
|c_CTRL-C| for |CmdlineLeave|). |c_CTRL-C| for |CmdlineLeave|).
chan |channel-id| chan |channel-id|
info Dict of arbitrary event data.
cmdlevel Level of cmdline. cmdlevel Level of cmdline.
cmdtype Type of cmdline, |cmdline-char|. cmdtype Type of cmdline, |cmdline-char|.
cwd Current working directory. cwd Current working directory.