aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/autocmd.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-04-30 04:30:21 -0700
committerGitHub <noreply@github.com>2024-04-30 04:30:21 -0700
commit71cf75f96a67aeb79ac3af6aa829bac81bd2d33d (patch)
treeb6582df55b2956fb2077f2d79c2cc7b6acf37c84 /src/nvim/api/autocmd.c
parentefaf37a2b9450d56acbf48a44c3c791d00d70199 (diff)
downloadrneovim-71cf75f96a67aeb79ac3af6aa829bac81bd2d33d.tar.gz
rneovim-71cf75f96a67aeb79ac3af6aa829bac81bd2d33d.tar.bz2
rneovim-71cf75f96a67aeb79ac3af6aa829bac81bd2d33d.zip
docs: misc #24163
- Also delete old perl scripts which are not used since 8+ years ago. fix #23251 fix #27367 ref https://github.com/neovim/neovim/issues/2252#issuecomment-1902662577 Helped-by: Daniel Kongsgaard <dakongsgaard@gmail.com> Co-authored-by: Kevin Pham <keevan.pham@gmail.com>
Diffstat (limited to 'src/nvim/api/autocmd.c')
-rw-r--r--src/nvim/api/autocmd.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/nvim/api/autocmd.c b/src/nvim/api/autocmd.c
index d71bcc4bcf..ca8367b7ce 100644
--- a/src/nvim/api/autocmd.c
+++ b/src/nvim/api/autocmd.c
@@ -381,15 +381,15 @@ cleanup:
/// - desc (string) optional: description (for documentation and troubleshooting).
/// - callback (function|string) optional: Lua function (or Vimscript function name, if
/// string) called when the event(s) is triggered. Lua callback can return a truthy
-/// value (not `false` or `nil`) to delete the autocommand. Receives a table argument
-/// with these keys:
+/// value (not `false` or `nil`) to delete the autocommand. Receives one argument,
+/// a table with these keys: [event-args]()
/// - id: (number) autocommand id
/// - event: (string) name of the triggered event |autocmd-events|
/// - group: (number|nil) autocommand group id, if any
/// - match: (string) expanded value of [<amatch>]
/// - buf: (number) expanded value of [<abuf>]
/// - file: (string) expanded value of [<afile>]
-/// - data: (any) arbitrary data passed from [nvim_exec_autocmds()]
+/// - data: (any) arbitrary data passed from [nvim_exec_autocmds()] [event-data]()
/// - command (string) optional: Vim command to execute on event. Cannot be used with
/// {callback}
/// - once (boolean) optional: defaults to false. Run the autocommand