GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-16 01:01:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: render @since versions, 0 means experimental #30649

Browse Source 
An implication of this current approach is that `NVIM_API_LEVEL` should be
bumped when a new Lua function is added.

TODO(future): add a lint check which requires `@since` on all new functions.

ref #25416
This commit is contained in:
Justin M. Keyes
2024-10-04 02:13:31 -07:00
committed by GitHub
parent f62728cd80
commit b45c50f314
16 changed files with 156 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
runtime/lua/vim/loader.lua
View File

@ -289,6 +289,9 @@ function Loader.load(modpath, opts)
end
--- Finds Lua modules for the given module name.
---
--- @since 0
---
---@param modname string Module name, or `"*"` to find the top-level modules instead
---@param opts? vim.loader.find.Opts Options for finding a module:
---@return vim.loader.ModuleInfo[]
@ -377,8 +380,10 @@ function M.find(modname, opts)
return results
end
--- Resets the cache for the path, or all the paths
--- if path is nil.
--- Resets the cache for the path, or all the paths if path is nil.
---
--- @since 0
---
---@param path string? path to reset
function M.reset(path)
if path then
@ -398,6 +403,8 @@ end
--- * adds the Lua loader using the byte-compilation cache
--- * adds the libs loader
--- * removes the default Nvim loader
---
--- @since 0
function M.enable()
if M.enabled then
return
@ -421,6 +428,8 @@ end
--- Disables the experimental Lua module loader:
--- * removes the loaders
--- * adds the default Nvim loader
---
--- @since 0
function M.disable()
if not M.enabled then
return