diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2019-12-02 00:46:46 -0800 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2019-12-02 22:06:42 -0800 |
| commit | a3b6c2a3dc5576db45fe4e893cfb8482af591c92 (patch) | |
| tree | 4b19d5f14230929c226ea916c1538fb492e511c0 /runtime/doc/api.txt | |
| parent | c34130d13a842ae0c0c1724d05800a954547d327 (diff) | |
| download | rneovim-a3b6c2a3dc5576db45fe4e893cfb8482af591c92.tar.gz rneovim-a3b6c2a3dc5576db45fe4e893cfb8482af591c92.tar.bz2 rneovim-a3b6c2a3dc5576db45fe4e893cfb8482af591c92.zip | |
API: rename nvim_execute_lua => nvim_exec_lua
- We already find ourselves renaming nvim_execute_lua in tests and
scripts, which suggests "exec" is the verb we actually want.
- Add "exec" verb to `:help dev-api`.
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index afb5630b50..d52a9a8409 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -483,7 +483,8 @@ nvim_exec({src}, {output}) *nvim_exec()* Executes Vimscript (multiline block of Ex-commands), like anonymous |:source|. - Optionally returns (non-error, non-shell |:!|) output. + Unlike |nvim_command()| this function supports heredocs, + script-scope (s:), etc. On execution error: fails with VimL error, does not update v:errmsg. @@ -493,6 +494,10 @@ nvim_exec({src}, {output}) *nvim_exec()* {output} Capture and return all (non-error, non-shell |:!|) output + Return: ~ + Output (non-error, non-shell |:!|) if `output` is true, + else empty string. + See also: ~ |execute()| |nvim_command()| @@ -643,7 +648,7 @@ nvim_eval({expr}) *nvim_eval()* Return: ~ Evaluation result or expanded object -nvim_execute_lua({code}, {args}) *nvim_execute_lua()* +nvim_exec_lua({code}, {args}) *nvim_exec_lua()* Execute Lua code. Parameters (if any) are available as `...` inside the chunk. The chunk can return a value. |