mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-22 03:08:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #17938 from ggandor/autocmd-api-names

Browse Source 
refactor(api)!: use singular/plural consistently in the autocmd API
This commit is contained in:
bfredl
2022-04-01 00:35:21 +02:00
committed by GitHub
parent 38ba2a75fc 9d40b2fda9
commit 80d4d6b486
4 changed files with 34 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/nvim/api/autocmd.c
View File

@@ -36,7 +36,7 @@
// Used to delete autocmds from nvim_del_autocmd
static int64_t next_autocmd_id = 1;
/// Get autocommands that match the requirements passed to {opts}.
/// Get all autocommands that match the corresponding {opts}.
///
/// These examples will get autocommands matching ALL the given criteria:
/// <pre>
@@ -568,7 +568,7 @@ void nvim_del_autocmd(Integer id, Error *err)
/// - group: (string|int) The augroup name or id.
/// - NOTE: If not passed, will only delete autocmds *not* in any group.
///
void nvim_clear_autocmd(Dict(clear_autocmd) *opts, Error *err)
void nvim_clear_autocmds(Dict(clear_autocmds) *opts, Error *err)
FUNC_API_SINCE(9)
{
// TODO(tjdevries): Future improvements:
@@ -711,7 +711,8 @@ void nvim_del_augroup_by_name(String name, Error *err)
});
}
/// Execute an autocommand |autocmd-execute|.
/// Execute all autocommands for {event} that match the corresponding
/// {opts} |autocmd-execute|.
/// @param event (String|Array) The event or events to execute
/// @param opts Dictionary of autocommand options:
/// - group (string|integer) optional: the autocommand group name or
@@ -723,7 +724,7 @@ void nvim_del_augroup_by_name(String name, Error *err)
/// - modeline (bool) optional: defaults to true. Process the
/// modeline after the autocommands |<nomodeline>|.
/// @see |:doautocmd|
void nvim_exec_autocmd(Object event, Dict(exec_autocmd) *opts, Error *err)
void nvim_exec_autocmds(Object event, Dict(exec_autocmds) *opts, Error *err)
FUNC_API_SINCE(9)
{
int au_group = AUGROUP_ALL;