aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/lua.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-11-26 06:15:50 -0800
committerGitHub <noreply@github.com>2024-11-26 06:15:50 -0800
commit3d707e6f14b7db64b3510f58bf9321c71163f552 (patch)
tree56dbbcc319691742aa0677693dc0714a014ec543 /runtime/doc/lua.txt
parent66bb1e577c96d8eb63c04dcc737394b4ce2b0f5d (diff)
downloadrneovim-3d707e6f14b7db64b3510f58bf9321c71163f552.tar.gz
rneovim-3d707e6f14b7db64b3510f58bf9321c71163f552.tar.bz2
rneovim-3d707e6f14b7db64b3510f58bf9321c71163f552.zip
fix(lua): remove vim.loader.disable() #31344
Problem: `vim.loader.disable` does not conform to `:help dev-name-common` and `:help dev-patterns`. Solution: - Add `enable` parameter to `vim.loader.enable` - Remove `vim.loader.disable` - Note the change in `:help news-breaking-dev` (HEAD changes). - This is not a breaking change (except to "HEAD") because `vim.loader` is marked "experimental". previous: 26765e8461c1ba1e9a351632212cf89900221781
Diffstat (limited to 'runtime/doc/lua.txt')
-rw-r--r--runtime/doc/lua.txt20
1 files changed, 11 insertions, 9 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 4d4a51872a..cf53825c68 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -2485,22 +2485,24 @@ vim.validate({name}, {value}, {validator}, {optional}, {message})
==============================================================================
Lua module: vim.loader *vim.loader*
-vim.loader.disable() *vim.loader.disable()*
+vim.loader.enable({enable}) *vim.loader.enable()*
WARNING: This feature is experimental/unstable.
- Disables the experimental Lua module loader:
- • removes the loaders
- • adds the default Nvim loader
+ Enables or disables the experimental Lua module loader:
-vim.loader.enable() *vim.loader.enable()*
- WARNING: This feature is experimental/unstable.
-
- Enables the experimental Lua module loader:
- • overrides loadfile
+ Enable (`enable=true`):
+ • overrides |loadfile()|
• adds the Lua loader using the byte-compilation cache
• adds the libs loader
• removes the default Nvim loader
+ Disable (`enable=false`):
+ • removes the loaders
+ • adds the default Nvim loader
+
+ Parameters: ~
+ • {enable} (`boolean?`) true/nil to enable, false to disable
+
vim.loader.find({modname}, {opts}) *vim.loader.find()*
WARNING: This feature is experimental/unstable.