diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-08-03 06:14:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-03 06:14:15 -0700 |
| commit | 4d859d00d13893815b6072a7bf2022dd89d5e3f8 (patch) | |
| tree | e536f6b205d59ffac0444990c4e60b0cb3398a27 /runtime/lua/vim/_meta/api.lua | |
| parent | f1772272b4fda43c093fc495f54b5e7c11968d62 (diff) | |
| parent | b1fb04475e6fa0c44895cb6fe97b75816d74c297 (diff) | |
| download | rneovim-4d859d00d13893815b6072a7bf2022dd89d5e3f8.tar.gz rneovim-4d859d00d13893815b6072a7bf2022dd89d5e3f8.tar.bz2 rneovim-4d859d00d13893815b6072a7bf2022dd89d5e3f8.zip | |
Merge #24351 docs
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 3622ba5d19..c0e4e35e7d 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -691,8 +691,8 @@ function vim.api.nvim_call_function(fn, args) end --- @param data string data to write. 8-bit clean: can contain NUL bytes. function vim.api.nvim_chan_send(chan, data) end ---- Clear all autocommands that match the corresponding {opts}. To delete a ---- particular autocmd, see `nvim_del_autocmd()`. +--- Clears all autocommands selected by {opts}. To delete autocmds see +--- `nvim_del_autocmd()`. --- --- @param opts vim.api.keyset.clear_autocmds Parameters --- • event: (string|table) Examples: @@ -919,10 +919,9 @@ function vim.api.nvim_del_augroup_by_id(id) end --- @param name string String The name of the group. function vim.api.nvim_del_augroup_by_name(name) end ---- Delete an autocommand by id. ---- NOTE: Only autocommands created via the API have an id. +--- Deletes an autocommand by id. --- ---- @param id integer Integer The id returned by nvim_create_autocmd +--- @param id integer Integer Autocommand id returned by `nvim_create_autocmd()` function vim.api.nvim_del_autocmd(id) end --- Deletes the current line. |