kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-19 18:55:14 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): update v:errmsg behavior #18593

Browse Source
This commit is contained in:
Famiu Haque 2022-05-17 18:27:33 +06:00 committed by GitHub
parent 6613f58ceb
commit 54b5222fbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
runtime/doc/api.txt
View File

@ -1725,8 +1725,7 @@ Vimscript Functions *api-vimscript*
nvim_call_dict_function({dict}, {fn}, {args}) nvim_call_dict_function({dict}, {fn}, {args})
Calls a VimL |Dictionary-function| with the given arguments. Calls a VimL |Dictionary-function| with the given arguments.
On execution error: fails with VimL error, does not update On execution error: fails with VimL error, updates v:errmsg.
v:errmsg.
Parameters: ~ Parameters: ~
{dict} Dictionary, or String evaluating to a VimL |self| {dict} Dictionary, or String evaluating to a VimL |self|
@ -1740,8 +1739,7 @@ nvim_call_dict_function({dict}, {fn}, {args})
nvim_call_function({fn}, {args}) *nvim_call_function()* nvim_call_function({fn}, {args}) *nvim_call_function()*
Calls a VimL function with the given arguments. Calls a VimL function with the given arguments.
On execution error: fails with VimL error, does not update On execution error: fails with VimL error, updates v:errmsg.
v:errmsg.
Parameters: ~ Parameters: ~
{fn} Function to call {fn} Function to call
@ -1760,6 +1758,8 @@ nvim_cmd({*cmd}, {*opts}) *nvim_cmd()*
argument, expanding filenames in a command that otherwise argument, expanding filenames in a command that otherwise
doesn't expand filenames, etc. doesn't expand filenames, etc.
On execution error: fails with VimL error, updates v:errmsg.
Parameters: ~ Parameters: ~
{cmd} Command to execute. Must be a Dictionary that can {cmd} Command to execute. Must be a Dictionary that can
contain the same values as the return value of contain the same values as the return value of
@ -1781,8 +1781,7 @@ nvim_cmd({*cmd}, {*opts}) *nvim_cmd()*
nvim_command({command}) *nvim_command()* nvim_command({command}) *nvim_command()*
Executes an Ex command. Executes an Ex command.
On execution error: fails with VimL error, does not update On execution error: fails with VimL error, updates v:errmsg.
v:errmsg.
Prefer using |nvim_cmd()| or |nvim_exec()| over this. To Prefer using |nvim_cmd()| or |nvim_exec()| over this. To
evaluate multiple lines of Vim script or an Ex command evaluate multiple lines of Vim script or an Ex command
@ -1798,8 +1797,7 @@ nvim_eval({expr}) *nvim_eval()*
Evaluates a VimL |expression|. Dictionaries and Lists are Evaluates a VimL |expression|. Dictionaries and Lists are
recursively expanded. recursively expanded.
On execution error: fails with VimL error, does not update On execution error: fails with VimL error, updates v:errmsg.
v:errmsg.
Parameters: ~ Parameters: ~
{expr} VimL expression string {expr} VimL expression string
@ -1814,8 +1812,7 @@ nvim_exec({src}, {output}) *nvim_exec()*
Unlike |nvim_command()| this function supports heredocs, Unlike |nvim_command()| this function supports heredocs,
script-scope (s:), etc. script-scope (s:), etc.
On execution error: fails with VimL error, does not update On execution error: fails with VimL error, updates v:errmsg.
v:errmsg.
Parameters: ~ Parameters: ~
{src} Vimscript code {src} Vimscript code

12
src/nvim/api/vimscript.c
View File

@ -34,7 +34,7 @@
/// Unlike |nvim_command()| this function supports heredocs, script-scope (s:), /// Unlike |nvim_command()| this function supports heredocs, script-scope (s:),
/// etc. /// etc.
/// ///
/// On execution error: fails with VimL error, does not update v:errmsg. /// On execution error: fails with VimL error, updates v:errmsg.
/// ///
/// @see |execute()| /// @see |execute()|
/// @see |nvim_command()| /// @see |nvim_command()|
@ -98,7 +98,7 @@ theend:
/// Executes an Ex command. /// Executes an Ex command.
/// ///
/// On execution error: fails with VimL error, does not update v:errmsg. /// On execution error: fails with VimL error, updates v:errmsg.
/// ///
/// Prefer using |nvim_cmd()| or |nvim_exec()| over this. To evaluate multiple lines of Vim script /// Prefer using |nvim_cmd()| or |nvim_exec()| over this. To evaluate multiple lines of Vim script
/// or an Ex command directly, use |nvim_exec()|. To construct an Ex command using a structured /// or an Ex command directly, use |nvim_exec()|. To construct an Ex command using a structured
@ -118,7 +118,7 @@ void nvim_command(String command, Error *err)
/// Evaluates a VimL |expression|. /// Evaluates a VimL |expression|.
/// Dictionaries and Lists are recursively expanded. /// Dictionaries and Lists are recursively expanded.
/// ///
/// On execution error: fails with VimL error, does not update v:errmsg. /// On execution error: fails with VimL error, updates v:errmsg.
/// ///
/// @param expr VimL expression string /// @param expr VimL expression string
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
@ -226,7 +226,7 @@ free_vim_args:
/// Calls a VimL function with the given arguments. /// Calls a VimL function with the given arguments.
/// ///
/// On execution error: fails with VimL error, does not update v:errmsg. /// On execution error: fails with VimL error, updates v:errmsg.
/// ///
/// @param fn Function to call /// @param fn Function to call
/// @param args Function arguments packed in an Array /// @param args Function arguments packed in an Array
@ -240,7 +240,7 @@ Object nvim_call_function(String fn, Array args, Error *err)
/// Calls a VimL |Dictionary-function| with the given arguments. /// Calls a VimL |Dictionary-function| with the given arguments.
/// ///
/// On execution error: fails with VimL error, does not update v:errmsg. /// On execution error: fails with VimL error, updates v:errmsg.
/// ///
/// @param dict Dictionary, or String evaluating to a VimL |self| dict /// @param dict Dictionary, or String evaluating to a VimL |self| dict
/// @param fn Name of the function defined on the VimL dict /// @param fn Name of the function defined on the VimL dict
@ -996,6 +996,8 @@ end:
/// such as having spaces inside a command argument, expanding filenames in a command that otherwise /// such as having spaces inside a command argument, expanding filenames in a command that otherwise
/// doesn't expand filenames, etc. /// doesn't expand filenames, etc.
/// ///
/// On execution error: fails with VimL error, updates v:errmsg.
///
/// @see |nvim_exec()| /// @see |nvim_exec()|
/// @see |nvim_command()| /// @see |nvim_command()|
/// ///