diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2025-01-09 06:36:29 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-09 06:36:29 -0800 |
| commit | 5135a232199047e473e3941b0b5a738c77fbecb5 (patch) | |
| tree | c6f964678048febab756f825e6cf76470017d89c /runtime/doc | |
| parent | dcaf8bef08d094889ef5fac24d123871dd0e6a6f (diff) | |
| parent | 5c92b40b4b173c7d85106689fef811e41994abb0 (diff) | |
| download | rneovim-5135a232199047e473e3941b0b5a738c77fbecb5.tar.gz rneovim-5135a232199047e473e3941b0b5a738c77fbecb5.tar.bz2 rneovim-5135a232199047e473e3941b0b5a738c77fbecb5.zip | |
Merge #31900 from luukvbaal/nvim_echo
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/api.txt | 26 | ||||
| -rw-r--r-- | runtime/doc/deprecated.txt | 3 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 2 |
3 files changed, 7 insertions, 24 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index c8e0dcd0c5..852037bb34 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -662,28 +662,13 @@ nvim_echo({chunks}, {history}, {opts}) *nvim_echo()* `hl_group` element can be omitted for no highlight. • {history} if true, add to |message-history|. • {opts} Optional parameters. + • err: Treat the message like |:echoerr|. Omitted `hlgroup` + uses |hl-ErrorMsg| instead. • verbose: Message is printed as a result of 'verbose' option. If Nvim was invoked with -V3log_file, the message will be redirected to the log_file and suppressed from direct output. -nvim_err_write({str}) *nvim_err_write()* - Writes a message to the Vim error buffer. Does not append "\n", the - message is buffered (won't display) until a linefeed is written. - - Parameters: ~ - • {str} Message - -nvim_err_writeln({str}) *nvim_err_writeln()* - Writes a message to the Vim error buffer. Appends "\n", so the buffer is - flushed (and displayed). - - Parameters: ~ - • {str} Message - - See also: ~ - • nvim_err_write() - nvim_eval_statusline({str}, {opts}) *nvim_eval_statusline()* Evaluates statusline string. @@ -1154,13 +1139,6 @@ nvim_open_term({buffer}, {opts}) *nvim_open_term()* Return: ~ Channel id, or 0 on error -nvim_out_write({str}) *nvim_out_write()* - Writes a message to the Vim output buffer. Does not append "\n", the - message is buffered (won't display) until a linefeed is written. - - Parameters: ~ - • {str} Message - nvim_paste({data}, {crlf}, {phase}) *nvim_paste()* Pastes at cursor (in any mode), and sets "redo" so dot (|.|) will repeat the input. UIs call this to implement "paste", but it's also intended for diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index ec98cc844f..dbdb8f541b 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -18,6 +18,9 @@ DEPRECATED IN 0.11 *deprecated-0.11* API • nvim_subscribe() Plugins must maintain their own "multicast" channels list. • nvim_unsubscribe() Plugins must maintain their own "multicast" channels list. +• nvim_out_write() Use |nvim_echo()|. +• nvim_err_write() Use |nvim_echo()| with `{err=true}`. +• nvim_err_writeln() Use |nvim_echo()| with `{err=true}`. DIAGNOSTICS • *vim.diagnostic.goto_next()* Use |vim.diagnostic.jump()| with `{count=1, float=true}` instead. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 931f5e117c..960b6f05f9 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -178,6 +178,8 @@ API • Improved API "meta" docstrings and :help documentation. • |nvim__ns_set()| can set properties for a namespace +• |nvim_echo()| `err` field to print error messages and `chunks` accepts + highlight group IDs. DEFAULTS |