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/lua | |
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/lua')
-rw-r--r-- | runtime/lua/vim/_meta/api.lua | 12 |
1 files changed, 4 insertions, 8 deletions
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 |