diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2025-03-18 06:18:37 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-03-18 06:18:37 -0700 |
| commit | 7333c39e6cc78786289d88c65fbe10e4ce78992b (patch) | |
| tree | af0deb9a02b82c19e6bf89e2b5bc8fb9123dd5d5 /runtime/lua/vim/_meta/api.lua | |
| parent | 29a47b39ccd0317e815632439966f0f1343d96cf (diff) | |
| download | rneovim-7333c39e6cc78786289d88c65fbe10e4ce78992b.tar.gz rneovim-7333c39e6cc78786289d88c65fbe10e4ce78992b.tar.bz2 rneovim-7333c39e6cc78786289d88c65fbe10e4ce78992b.zip | |
docs: misc #32959
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index ece3c1854b..2c1fb260b2 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -885,7 +885,7 @@ function vim.api.nvim_command_output(command) end --- To get an existing group id, do: --- --- ```lua ---- local id = vim.api.nvim_create_augroup("MyGroup", { +--- local id = vim.api.nvim_create_augroup('my.lsp.config', { --- clear = false --- }) --- ``` @@ -904,8 +904,8 @@ function vim.api.nvim_create_augroup(name, opts) end --- Example using Lua callback: --- --- ```lua ---- vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, { ---- pattern = {"*.c", "*.h"}, +--- vim.api.nvim_create_autocmd({'BufEnter', 'BufWinEnter'}, { +--- pattern = {'*.c', '*.h'}, --- callback = function(ev) --- print(string.format('event fired: %s', vim.inspect(ev))) --- end @@ -915,8 +915,8 @@ function vim.api.nvim_create_augroup(name, opts) end --- Example using an Ex command as the handler: --- --- ```lua ---- vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, { ---- pattern = {"*.c", "*.h"}, +--- vim.api.nvim_create_autocmd({'BufEnter', 'BufWinEnter'}, { +--- pattern = {'*.c', '*.h'}, --- command = "echo 'Entering a C or C++ file'", --- }) --- ``` @@ -925,7 +925,7 @@ function vim.api.nvim_create_augroup(name, opts) end --- and "~" must be expanded explicitly: --- --- ```lua ---- pattern = vim.fn.expand("~") .. "/some/path/*.py" +--- pattern = vim.fn.expand('~') .. '/some/path/*.py' --- ``` --- --- @see `:help autocommand` @@ -1222,14 +1222,14 @@ function vim.api.nvim_get_all_options_info() end --- ```lua --- -- Matches all criteria --- autocommands = vim.api.nvim_get_autocmds({ ---- group = "MyGroup", ---- event = {"BufEnter", "BufWinEnter"}, ---- pattern = {"*.c", "*.h"} +--- group = 'MyGroup', +--- event = {'BufEnter', 'BufWinEnter'}, +--- pattern = {'*.c', '*.h'} --- }) --- --- -- All commands from one group --- autocommands = vim.api.nvim_get_autocmds({ ---- group = "MyGroup", +--- group = 'MyGroup', --- }) --- ``` --- |