From c3a4686fa18715ff373b0aedc34eb08a6a735e7c Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Tue, 10 Dec 2024 23:34:08 +0300
Subject: [PATCH] wrapper/rc: use `mkOption` in `enableLuaLoader` description

`mkEnableOption` seems to be clobbering the markdown syntax.
---
 modules/wrapper/rc/options.nix | 32 +++++++++++++++++++-------------
 1 file changed, 19 insertions(+), 13 deletions(-)

diff --git a/modules/wrapper/rc/options.nix b/modules/wrapper/rc/options.nix
index 4680190..ab54141 100644
--- a/modules/wrapper/rc/options.nix
+++ b/modules/wrapper/rc/options.nix
@@ -12,22 +12,28 @@
   cfg = config.vim;
 in {
   options.vim = {
-    enableLuaLoader = mkEnableOption ''
-      [{option}`official documentation`]: https://neovim.io/doc/user/lua.html#vim.loader.enable()
+    enableLuaLoader = mkOption {
+      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:
-        - overrides loadfile
-        - adds the lua loader using the byte-compilation cache
-        - adds the libs loader
-        - removes the default Neovim loader
+        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
 
-      ::: {.note}
-      This is disabled by default. Before setting this option, please
-      take a look at the [{option}`official documentation`].
-      :::
-    '';
+        ::: {.note}
+        The Lua module loader is *disabled* by default. Before setting this option, please
+        take a look at the [{option}`official documentation`]. This option may be enabled by
+        default in the future.
+        :::
+      '';
+    };
 
     additionalRuntimePaths = mkOption {
       type = listOf (either path str);