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

docs(api): fix wrong documentation of nvim_create_autocmd (#17870)

Browse Source 
also add doc changes from typofix PR
This commit is contained in:
かわえもん
2022-03-26 21:21:32 +09:00
committed by GitHub
parent fb5587d2be
commit 85821d8b6f
2 changed files with 12 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
runtime/doc/api.txt
View File

@@ -1802,7 +1802,7 @@ nvim_parse_expression({expr}, {flags}, {highlight})
there for debugging purposes primary (debugging there for debugging purposes primary (debugging
parser and providing debug information). parser and providing debug information).
• "children": a list of nodes described in top/"ast". • "children": a list of nodes described in top/"ast".
There is always zero, one or two children, key will There always is zero, one or two children, key will
not be present if node has no children. Maximum not be present if node has no children. Maximum
number of children may be found in node_maxchildren number of children may be found in node_maxchildren
array. array.
@@ -1967,7 +1967,7 @@ nvim_buf_call({buffer}, {fun}) *nvim_buf_call()*
current window already shows "buffer", the window is not current window already shows "buffer", the window is not
switched If a window inside the current tabpage (including a switched If a window inside the current tabpage (including a
float) already shows the buffer One of these windows will be float) already shows the buffer One of these windows will be
set as current window temporarily. Otherwise, a temporary set as current window temporarily. Otherwise a temporary
scratch window (called the "autocmd window" for historical scratch window (called the "autocmd window" for historical
reasons) will be used. reasons) will be used.
@@ -2362,7 +2362,7 @@ nvim_buf_add_highlight({buffer}, {ns_id}, {hl_group}, {line}, {col_start},
it in to this function as `ns_id` to add highlights to the it in to this function as `ns_id` to add highlights to the
namespace. All highlights in the same namespace can then be namespace. All highlights in the same namespace can then be
cleared with single call to |nvim_buf_clear_namespace()|. If cleared with single call to |nvim_buf_clear_namespace()|. If
the highlight will never be deleted by an API call, pass the highlight never will be deleted by an API call, pass
`ns_id = -1`. `ns_id = -1`.
As a shorthand, `ns_id = 0` can be used to create a new As a shorthand, `ns_id = 0` can be used to create a new
@@ -3029,7 +3029,7 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
double box style could be specified as [ double box style could be specified as [
"╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ]. If "╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ]. If
the number of chars are less than eight, the number of chars are less than eight,
they will be repeated. Thus, an ASCII border they will be repeated. Thus an ASCII border
could be specified as [ "/", "-", "\\", "|" could be specified as [ "/", "-", "\\", "|"
], or all chars the same as [ "x" ]. An ], or all chars the same as [ "x" ]. An
empty string can be used to turn off a empty string can be used to turn off a
@@ -3188,16 +3188,14 @@ nvim_create_autocmd({event}, {*opts}) *nvim_create_autocmd()*
-- Vimscript function name (as a string) -- Vimscript function name (as a string)
local myvimfun = "g:MyVimFunction" local myvimfun = "g:MyVimFunction"
vim.api.nvim_create_autocmd({ vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
event = {"BufEnter", "BufWinEnter"},
pattern = {"*.c", "*.h"}, pattern = {"*.c", "*.h"},
callback = myluafun, -- Or myvimfun callback = myluafun, -- Or myvimfun
}) })
< <
Example using command: > Example using command: >
vim.api.nvim_create_autocmd({ vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
event = {"BufEnter", "BufWinEnter"},
pattern = {"*.c", "*.h"}, pattern = {"*.c", "*.h"},
command = "echo 'Entering a C or C++ file'", command = "echo 'Entering a C or C++ file'",
}) })
@@ -3209,8 +3207,8 @@ nvim_create_autocmd({event}, {*opts}) *nvim_create_autocmd()*
< <
Examples values for event: > Examples values for event: >
event = "BufPreWrite" "BufPreWrite"
event = {"CursorHold", "BufPreWrite", "BufPostWrite"} {"CursorHold", "BufPreWrite", "BufPostWrite"}
< <
Parameters: ~ Parameters: ~

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

@@ -340,8 +340,7 @@ cleanup:
/// -- Vimscript function name (as a string) /// -- Vimscript function name (as a string)
/// local myvimfun = "g:MyVimFunction" /// local myvimfun = "g:MyVimFunction"
/// ///
/// vim.api.nvim_create_autocmd({ /// vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
/// event = {"BufEnter", "BufWinEnter"},
/// pattern = {"*.c", "*.h"}, /// pattern = {"*.c", "*.h"},
/// callback = myluafun, -- Or myvimfun /// callback = myluafun, -- Or myvimfun
/// }) /// })
@@ -349,8 +348,7 @@ cleanup:
/// ///
/// Example using command: /// Example using command:
/// <pre> /// <pre>
/// vim.api.nvim_create_autocmd({ /// vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
/// event = {"BufEnter", "BufWinEnter"},
/// pattern = {"*.c", "*.h"}, /// pattern = {"*.c", "*.h"},
/// command = "echo 'Entering a C or C++ file'", /// command = "echo 'Entering a C or C++ file'",
/// }) /// })
@@ -364,8 +362,8 @@ cleanup:
/// ///
/// Examples values for event: /// Examples values for event:
/// <pre> /// <pre>
/// event = "BufPreWrite" /// "BufPreWrite"
/// event = {"CursorHold", "BufPreWrite", "BufPostWrite"} /// {"CursorHold", "BufPreWrite", "BufPostWrite"}
/// </pre> /// </pre>
/// ///
/// @param event (String|Array) The event or events to register this autocommand /// @param event (String|Array) The event or events to register this autocommand