docs: add lua typing for vim.NIL

This commit is contained in:
Jongwook Choi 2024-01-14 22:37:07 -05:00 committed by Lewis Russell
parent 965dbd0e01
commit 4d91604c88
5 changed files with 13 additions and 4 deletions

View File

@ -1829,7 +1829,8 @@ lookup_section({settings}, {section}) *vim.lsp.util.lookup_section()*
• {section} (`string`) indicating the field of the settings table • {section} (`string`) indicating the field of the settings table
Return: ~ Return: ~
(`table|string`) The value of settings accessed via section (`table|string|vim.NIL`) The value of settings accessed via section.
`vim.NIL` if not found.
*vim.lsp.util.make_floating_popup_options()* *vim.lsp.util.make_floating_popup_options()*
make_floating_popup_options({width}, {height}, {opts}) make_floating_popup_options({width}, {height}, {opts})

View File

@ -1,7 +1,8 @@
---@meta ---@meta
-- luacheck: no unused args -- luacheck: no unused args
error('Cannot require a meta file')
---@defgroup vim.builtin ---@defgroup vim.builtin
--- ---
---@brief <pre>help ---@brief <pre>help
@ -62,6 +63,12 @@
--- ---
---</pre> ---</pre>
---@class vim.NIL
---@type vim.NIL
---@nodoc
vim.NIL = ...
--- Returns true if the code is executing as part of a "fast" event handler, --- Returns true if the code is executing as part of a "fast" event handler,
--- where most of the API is disabled. These are low-level events (e.g. --- where most of the API is disabled. These are low-level events (e.g.
--- |lua-loop-callbacks|) which can be invoked whenever Nvim polls for input. --- |lua-loop-callbacks|) which can be invoked whenever Nvim polls for input.

View File

@ -427,7 +427,7 @@ vim.v.msgpack_types = ...
--- In some places `v:null` can be used for a List, Dict, etc. --- In some places `v:null` can be used for a List, Dict, etc.
--- that is not set. That is slightly different than an empty --- that is not set. That is slightly different than an empty
--- List, Dict, etc. --- List, Dict, etc.
--- @type any --- @type vim.NIL
vim.v.null = ... vim.v.null = ...
--- Maximum value of a number. --- Maximum value of a number.

View File

@ -2139,7 +2139,7 @@ end
--- ---
---@param settings table language server settings ---@param settings table language server settings
---@param section string indicating the field of the settings table ---@param section string indicating the field of the settings table
---@return table|string The value of settings accessed via section ---@return table|string|vim.NIL The value of settings accessed via section. `vim.NIL` if not found.
function M.lookup_section(settings, section) function M.lookup_section(settings, section)
for part in vim.gsplit(section, '.', { plain = true }) do for part in vim.gsplit(section, '.', { plain = true }) do
settings = settings[part] settings = settings[part]

View File

@ -469,6 +469,7 @@ M.vars = {
]=], ]=],
}, },
null = { null = {
type = 'vim.NIL',
desc = [=[ desc = [=[
Special value used to put "null" in JSON and NIL in msgpack. Special value used to put "null" in JSON and NIL in msgpack.
See |json_encode()|. This value is converted to "v:null" when See |json_encode()|. This value is converted to "v:null" when