From be0fd17510d9493f9bbe9eeb59a85cd469c7d708 Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Sun, 21 Apr 2024 02:34:47 +0300
Subject: [PATCH] wrapper/rc: document `enableLuaLoader` better; link to docs

---
 modules/wrapper/rc/options.nix | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/modules/wrapper/rc/options.nix b/modules/wrapper/rc/options.nix
index fbd0afa..c67cf1e 100644
--- a/modules/wrapper/rc/options.nix
+++ b/modules/wrapper/rc/options.nix
@@ -5,7 +5,7 @@
 }: let
   inherit (lib.options) mkOption mkEnableOption literalMD literalExpression;
   inherit (lib.strings) optionalString;
-  inherit (lib.types) str oneOf attrs lines listOf either path;
+  inherit (lib.types) str oneOf attrs lines listOf either path bool;
   inherit (lib.nvim.types) dagOf;
   inherit (lib.nvim.lua) listToLuaTable;
   cfg = config.vim;
@@ -13,6 +13,15 @@ in {
   options.vim = {
     enableLuaLoader = mkEnableOption ''
       the experimental Lua module loader to speed up the start up process
+
+      If `true`, this will enable the experimental Lua module loader which:
+        - overrides loadfile
+        - adds the lua loader using the byte-compilation cache
+        - adds the libs loader
+        - removes the default Neovim loader
+
+      This is disabled by default. Before setting this option, please
+      take a look at the [{option}`official documentation`](https://neovim.io/doc/user/lua.html#vim.loader.enable()).
     '';
 
     additionalRuntimePaths = mkOption {
@@ -20,10 +29,11 @@ in {
       default = [];
       example = literalExpression ''
         [
-          "~/.config/nvim-extra" # absolute path, as a string - impure
+          "$HOME/.config/nvim-extra" # absolute path, as a string - impure
           ./nvim # relative path, as a path - pure
         ]
       '';
+
       description = ''
         Additional runtime paths that will be appended to the
         active runtimepath of the Neovim. This can be used to