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

chore(docs): clarify vim.notify log_level parameter (#16436)

Browse Source
This commit is contained in:
Mathias Fußenegger 2021-11-25 20:06:42 +01:00 committed by GitHub
parent 150a5922aa
commit 72d62aa6aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
runtime/doc/lua.txt
View File

@ -1200,20 +1200,16 @@ inspect({object}, {options}) *vim.inspect()*
https://github.com/kikito/inspect.lua
https://github.com/mpeterv/vinspect
make_dict_accessor({scope}, {handle}) *vim.make_dict_accessor()*
TODO: Documentation
notify({msg}, {log_level}, {_opts}) *vim.notify()*
notify({msg}, {log_level}, {opts}) *vim.notify()*
Notification provider
Without a runtime, writes to :Messages
Parameters: ~
{msg} Content of the notification to show to the
user
{log_level} Optional log level
{opts} Dictionary with optional options (timeout,
etc)
{msg} string Content of the notification to show to
the user
{log_level} number|nil enum from vim.log.levels
{opts} table|nil additional options (timeout, etc)
See also: ~
:help nvim_notify

10
src/nvim/lua/vim.lua
View File

@ -323,6 +323,7 @@ end
do
local validate = vim.validate
--@private
local function make_dict_accessor(scope, handle)
validate {
scope = {scope, 's'};
@ -422,11 +423,10 @@ end
---
--- Without a runtime, writes to :Messages
---@see :help nvim_notify
---@param msg Content of the notification to show to the user
---@param log_level Optional log level
---@param opts Dictionary with optional options (timeout, etc)
function vim.notify(msg, log_level, _opts)
---@param msg string Content of the notification to show to the user
---@param log_level number|nil enum from vim.log.levels
---@param opts table|nil additional options (timeout, etc)
function vim.notify(msg, log_level, opts) -- luacheck: no unused
if log_level == vim.log.levels.ERROR then
vim.api.nvim_err_writeln(msg)
elseif log_level == vim.log.levels.WARN then