NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-12-28 13:42:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

wrapper/rc: use mkOption in enableLuaLoader description

Browse source 
`mkEnableOption` seems to be clobbering the markdown syntax.
This commit is contained in:
raf 2024-12-10 23:34:08 +03:00
parent cece170a41
commit c3a4686fa1
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 19 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
modules/wrapper/rc/options.nix
View file

@ -12,22 +12,28 @@
cfg = config.vim; cfg = config.vim;
in { in {
options.vim = { options.vim = {
enableLuaLoader = mkEnableOption '' enableLuaLoader = mkOption {
[{option}`official documentation`]: https://neovim.io/doc/user/lua.html#vim.loader.enable() type = bool;
default = false;
example = true;
description = ''
[{option}`official documentation`]: https://neovim.io/doc/user/lua.html#vim.loader.enable()
the experimental Lua module loader to speed up the start up process the experimental Lua module loader to speed up the start up process
If `true`, this will enable the experimental Lua module loader which: If `true`, this will enable the experimental Lua module loader which:
- overrides loadfile - overrides loadfile
- adds the lua loader using the byte-compilation cache - adds the lua loader using the byte-compilation cache
- adds the libs loader - adds the libs loader
- removes the default Neovim loader - removes the default Neovim loader
::: {.note} ::: {.note}
This is disabled by default. Before setting this option, please The Lua module loader is *disabled* by default. Before setting this option, please
take a look at the [{option}`official documentation`]. take a look at the [{option}`official documentation`]. This option may be enabled by
::: default in the future.
''; :::
'';
};
additionalRuntimePaths = mkOption { additionalRuntimePaths = mkOption {
type = listOf (either path str); type = listOf (either path str);