diff options
| author | bfredl <bjorn.linse@gmail.com> | 2022-04-01 00:35:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-01 00:35:21 +0200 |
| commit | 80d4d6b486c62d750b9a08ed5ed888d9a5d3ac48 (patch) | |
| tree | fe79699c43e768863f1242f165866789dc0c490a /runtime/doc | |
| parent | 38ba2a75fcbb3a893bf8b22838ed06fec6228509 (diff) | |
| parent | 9d40b2fda96709a8219369316a5768ca4b689e4f (diff) | |
| download | rneovim-80d4d6b486c62d750b9a08ed5ed888d9a5d3ac48.tar.gz rneovim-80d4d6b486c62d750b9a08ed5ed888d9a5d3ac48.tar.bz2 rneovim-80d4d6b486c62d750b9a08ed5ed888d9a5d3ac48.zip | |
Merge pull request #17938 from ggandor/autocmd-api-names
refactor(api)!: use singular/plural consistently in the autocmd API
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/api.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 2b9aef2d77..b383c5eaef 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -3151,7 +3151,7 @@ nvim_tabpage_set_var({tabpage}, {name}, {value}) ============================================================================== Autocmd Functions *api-autocmd* -nvim_clear_autocmd({*opts}) *nvim_clear_autocmd()* +nvim_clear_autocmds({*opts}) *nvim_clear_autocmds()* Clear all autocommands that match the corresponding {opts}. To delete a particular autocmd, see |nvim_del_autocmd|. @@ -3310,8 +3310,9 @@ nvim_del_autocmd({id}) *nvim_del_autocmd()* See also: ~ |nvim_create_autocmd()| -nvim_exec_autocmd({event}, {*opts}) *nvim_exec_autocmd()* - Execute an autocommand |autocmd-execute|. +nvim_exec_autocmds({event}, {*opts}) *nvim_exec_autocmds()* + Execute all autocommands for {event} that match the + corresponding {opts} |autocmd-execute|. Parameters: ~ {event} (String|Array) The event or events to execute @@ -3333,7 +3334,7 @@ nvim_exec_autocmd({event}, {*opts}) *nvim_exec_autocmd()* |:doautocmd| nvim_get_autocmds({*opts}) *nvim_get_autocmds()* - 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: > |