diff options
| author | かわえもん <me@kawaemon.dev> | 2022-03-26 21:21:32 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-26 13:21:32 +0100 |
| commit | 85821d8b6fa366f7361f84e07e62dc8fc951f26d (patch) | |
| tree | c7deab6af2c7f5c426e5abd1032856cc1f5b2aa5 /src | |
| parent | fb5587d2bede0cc091b92731b990bd2e394e9914 (diff) | |
| download | rneovim-85821d8b6fa366f7361f84e07e62dc8fc951f26d.tar.gz rneovim-85821d8b6fa366f7361f84e07e62dc8fc951f26d.tar.bz2 rneovim-85821d8b6fa366f7361f84e07e62dc8fc951f26d.zip | |
docs(api): fix wrong documentation of `nvim_create_autocmd` (#17870)
also add doc changes from typofix PR
Diffstat (limited to 'src')
| -rw-r--r-- | src/nvim/api/autocmd.c | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/src/nvim/api/autocmd.c b/src/nvim/api/autocmd.c index 94a24705d0..9aaa0418dc 100644 --- a/src/nvim/api/autocmd.c +++ b/src/nvim/api/autocmd.c @@ -340,8 +340,7 @@ cleanup: /// -- Vimscript function name (as a string) /// local myvimfun = "g:MyVimFunction" /// -/// vim.api.nvim_create_autocmd({ -/// event = {"BufEnter", "BufWinEnter"}, +/// vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, { /// pattern = {"*.c", "*.h"}, /// callback = myluafun, -- Or myvimfun /// }) @@ -349,8 +348,7 @@ cleanup: /// /// Example using command: /// <pre> -/// vim.api.nvim_create_autocmd({ -/// event = {"BufEnter", "BufWinEnter"}, +/// vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, { /// pattern = {"*.c", "*.h"}, /// command = "echo 'Entering a C or C++ file'", /// }) @@ -364,8 +362,8 @@ cleanup: /// /// Examples values for event: /// <pre> -/// event = "BufPreWrite" -/// event = {"CursorHold", "BufPreWrite", "BufPostWrite"} +/// "BufPreWrite" +/// {"CursorHold", "BufPreWrite", "BufPostWrite"} /// </pre> /// /// @param event (String|Array) The event or events to register this autocommand |