diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2025-01-10 11:42:04 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-10 11:42:04 -0800 |
| commit | 0717dfbfaf36887dab277527eb0a93bf2182297c (patch) | |
| tree | 72e3fe8fd597abde9b7beafdf0eb43659674ccb1 /runtime | |
| parent | b06f42b5023b2eec576e5bf22cdacd4c1ee4a939 (diff) | |
| download | rneovim-0717dfbfaf36887dab277527eb0a93bf2182297c.tar.gz rneovim-0717dfbfaf36887dab277527eb0a93bf2182297c.tar.bz2 rneovim-0717dfbfaf36887dab277527eb0a93bf2182297c.zip | |
refactor(api): deprecate nvim_notify #31938
Problem:
The `nvim_notify` API (note: unrelated to `vim.notify()` Lua API) was
not given any real motivation in https://github.com/neovim/neovim/pull/13843
There are, and were, idiomatic and ergonomic alternatives already.
Solution:
Deprecate `nvim_notify`.
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 11 | ||||
| -rw-r--r-- | runtime/doc/deprecated.txt | 1 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 12 |
3 files changed, 5 insertions, 19 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 9e84dd40ac..572e5e4267 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1094,17 +1094,6 @@ nvim_load_context({dict}) *nvim_load_context()* Parameters: ~ • {dict} |Context| map. -nvim_notify({msg}, {log_level}, {opts}) *nvim_notify()* - Notify the user with a message - - Relays the call to vim.notify . By default forwards your message in the - echo area but can be overridden to trigger desktop notifications. - - Parameters: ~ - • {msg} Message to display to the user - • {log_level} The log level - • {opts} Reserved for future use. - nvim_open_term({buffer}, {opts}) *nvim_open_term()* Open a terminal instance in a buffer diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index dbdb8f541b..4f320aeab3 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -16,6 +16,7 @@ Deprecated features DEPRECATED IN 0.11 *deprecated-0.11* API +• nvim_notify() Use |nvim_echo()| or `nvim_exec_lua("vim.notify(...)", ...)` instead. • 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()|. diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index b5d8a0937d..8930f131f6 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -1647,14 +1647,10 @@ function vim.api.nvim_list_wins() end --- @return any function vim.api.nvim_load_context(dict) end ---- Notify the user with a message ---- ---- Relays the call to vim.notify . By default forwards your message in the ---- echo area but can be overridden to trigger desktop notifications. ---- ---- @param msg string Message to display to the user ---- @param log_level integer The log level ---- @param opts table<string,any> Reserved for future use. +--- @deprecated +--- @param msg string +--- @param log_level integer +--- @param opts table<string,any> --- @return any function vim.api.nvim_notify(msg, log_level, opts) end |