diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2023-06-22 03:44:51 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-22 03:44:51 -0700 |
commit | 4e6356559c8cd44dbcaa765d1f39e176064526ec (patch) | |
tree | 84354e7d3c5a49b7edbc314da2e2b834d275d42c /runtime/doc/api.txt | |
parent | f4f1ce1d167c557e54153f74cf0f55245b8fd414 (diff) | |
download | rneovim-4e6356559c8cd44dbcaa765d1f39e176064526ec.tar.gz rneovim-4e6356559c8cd44dbcaa765d1f39e176064526ec.tar.bz2 rneovim-4e6356559c8cd44dbcaa765d1f39e176064526ec.zip |
test: spellcheck :help (vimdoc) files #24109
Enforce consistent terminology (defined in
`gen_help_html.lua:spell_dict`) for common misspellings.
This does not spellcheck English in general (perhaps a future TODO,
though it may be noisy).
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r-- | runtime/doc/api.txt | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 9adca7620f..bd8bce9737 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -7,7 +7,7 @@ Nvim API *API* *api* Nvim exposes a powerful API that can be used by plugins and external processes -via |RPC|, |Lua| and VimL (|eval-api|). +via |RPC|, |Lua| and Vimscript (|eval-api|). Applications can also embed libnvim to work with the C API directly. @@ -587,7 +587,7 @@ nvim__get_runtime({pat}, {all}, {*opts}) *nvim__get_runtime()* Parameters: ~ • {pat} pattern of files to search for • {all} whether to return all matches or only the first - • {opts} is_lua: only search lua subdirs + • {opts} is_lua: only search Lua subdirs Return: ~ list of absolute paths to the found files @@ -1203,7 +1203,7 @@ nvim_open_term({buffer}, {opts}) *nvim_open_term()* Parameters: ~ • {buffer} the buffer to use (expected to be empty) • {opts} Optional parameters. - • on_input: lua callback for input sent, i e keypresses in + • on_input: Lua callback for input sent, i e keypresses in terminal mode. Note: keypresses are sent raw as they would be to the pty master end. For instance, a carriage return is sent as a "\r", not as a "\n". |textlock| applies. It @@ -1556,22 +1556,22 @@ Vimscript Functions *api-vimscript* *nvim_call_dict_function()* nvim_call_dict_function({dict}, {fn}, {args}) - Calls a VimL |Dictionary-function| with the given arguments. + Calls a Vimscript |Dictionary-function| with the given arguments. - On execution error: fails with VimL error, updates v:errmsg. + On execution error: fails with Vimscript error, updates v:errmsg. Parameters: ~ - • {dict} Dictionary, or String evaluating to a VimL |self| dict - • {fn} Name of the function defined on the VimL dict + • {dict} Dictionary, or String evaluating to a Vimscript |self| dict + • {fn} Name of the function defined on the Vimscript dict • {args} Function arguments packed in an Array Return: ~ Result of the function call nvim_call_function({fn}, {args}) *nvim_call_function()* - Calls a VimL function with the given arguments. + Calls a Vimscript function with the given arguments. - On execution error: fails with VimL error, updates v:errmsg. + On execution error: fails with Vimscript error, updates v:errmsg. Parameters: ~ • {fn} Function to call @@ -1583,7 +1583,7 @@ nvim_call_function({fn}, {args}) *nvim_call_function()* nvim_command({command}) *nvim_command()* Executes an Ex command. - On execution error: fails with VimL error, updates v:errmsg. + On execution error: fails with Vimscript error, updates v:errmsg. Prefer using |nvim_cmd()| or |nvim_exec2()| over this. To evaluate multiple lines of Vim script or an Ex command directly, use @@ -1595,13 +1595,13 @@ nvim_command({command}) *nvim_command()* • {command} Ex command string nvim_eval({expr}) *nvim_eval()* - Evaluates a VimL |expression|. Dictionaries and Lists are recursively + Evaluates a Vimscript |expression|. Dictionaries and Lists are recursively expanded. - On execution error: fails with VimL error, updates v:errmsg. + On execution error: fails with Vimscript error, updates v:errmsg. Parameters: ~ - • {expr} VimL expression string + • {expr} Vimscript expression string Return: ~ Evaluation result or expanded object @@ -1613,7 +1613,7 @@ nvim_exec2({src}, {*opts}) *nvim_exec2()* Unlike |nvim_command()| this function supports heredocs, script-scope (s:), etc. - On execution error: fails with VimL error, updates v:errmsg. + On execution error: fails with Vimscript error, updates v:errmsg. Parameters: ~ • {src} Vimscript code @@ -1632,7 +1632,7 @@ nvim_exec2({src}, {*opts}) *nvim_exec2()* *nvim_parse_expression()* nvim_parse_expression({expr}, {flags}, {highlight}) - Parse a VimL expression. + Parse a Vimscript expression. Attributes: ~ |api-fast| @@ -1760,7 +1760,7 @@ nvim_cmd({*cmd}, {*opts}) *nvim_cmd()* example, instead of `vim.cmd.bdelete{ count = 2 }`, you may do `vim.cmd.bdelete(2)`. - On execution error: fails with VimL error, updates v:errmsg. + On execution error: fails with Vimscript error, updates v:errmsg. Parameters: ~ • {cmd} Command to execute. Must be a Dictionary that can contain the @@ -2055,7 +2055,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()* • deleted_codepoints (if `utf_sizes` is true) • deleted_codeunits (if `utf_sizes` is true) - • on_bytes: lua callback invoked on change. This + • on_bytes: Lua callback invoked on change. This callback receives more granular information about the change compared to on_lines. Return `true` to detach. Args: • the string "bytes" @@ -2118,12 +2118,12 @@ nvim_buf_call({buffer}, {fun}) *nvim_buf_call()* Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer - • {fun} Function to call inside the buffer (currently lua callable + • {fun} Function to call inside the buffer (currently Lua callable only) Return: ~ - Return value of function. NB: will deepcopy lua values currently, use - upvalues to send lua references in and out. + Return value of function. NB: will deepcopy Lua values currently, use + upvalues to send Lua references in and out. nvim_buf_del_keymap({buffer}, {mode}, {lhs}) *nvim_buf_del_keymap()* Unmaps a buffer-local |mapping| for the given mode. @@ -2720,7 +2720,7 @@ nvim_get_namespaces() *nvim_get_namespaces()* nvim_set_decoration_provider({ns_id}, {*opts}) Set or change decoration provider for a |namespace| - This is a very general purpose interface for having lua callbacks being + This is a very general purpose interface for having Lua callbacks being triggered during the redraw code. The expected usage is to set |extmarks| for the currently redrawn buffer. @@ -2776,12 +2776,12 @@ nvim_win_call({window}, {fun}) *nvim_win_call()* Parameters: ~ • {window} Window handle, or 0 for current window - • {fun} Function to call inside the window (currently lua callable + • {fun} Function to call inside the window (currently Lua callable only) Return: ~ - Return value of function. NB: will deepcopy lua values currently, use - upvalues to send lua references in and out. + Return value of function. NB: will deepcopy Lua values currently, use + upvalues to send Lua references in and out. See also: ~ • |win_execute()| |