From 03888986482b1a3079acfbe41e6580d059c27be7 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sat, 20 Apr 2024 19:01:54 +0300 Subject: [PATCH] docs: fix build failures due to `literalMD` --- modules/wrapper/build/config.nix | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/modules/wrapper/build/config.nix b/modules/wrapper/build/config.nix index 17c3695..9cd7183 100644 --- a/modules/wrapper/build/config.nix +++ b/modules/wrapper/build/config.nix @@ -229,7 +229,9 @@ in { if [vim.enableLuaLoader](#opt-vim.enableLuaLoader) is set to true. ''; - description = literalMD '' + example = literalExpression ''"$${builtins.readFile ./my-lua-config-pre.lua}"''; + + description = '' Verbatim lua code that will be inserted **before** the result of `luaConfigRc` DAG has been resolved. @@ -238,9 +240,11 @@ in { of lua configs after the DAG result. ::: {.warning} - You do not want to override this option. It is used - internally to set certain options as early as possible - and should be avoided unless you know what you're doing. + You do not want to override this option with mkForce + It is used internally to set certain options as early + as possible and should be avoided unless you know what + you're doing. Passing a string to this option will + merge it with the default contents. ::: ''; }; @@ -269,8 +273,9 @@ in { luaConfigPost = mkOption { type = str; default = ""; + example = literalExpression ''"$${builtins.readFile ./my-lua-config-post.lua}"''; description = '' - Verbatim lua code that will be inserted after + Verbatim lua code that will be inserted **after** the result of the `luaConfigRc` DAG has been resolved This option **does not** take a DAG set, but a string