Skip to content

Commit 2149270

Browse files
committed
fix defaultText for pkgs option using literalMD
Passing a non-literal string to `example` or `defaultText` causes the docs to render the value using `lib.generators.toPretty`. If you want to use markdown, use `literalMD`. If you want to pass a nix expression, use `literalExpression`.
1 parent 750dfb5 commit 2149270

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

flake-module.nix

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ in
2424
modules = (import ./.).submodule-modules ++ [{
2525
options.pkgs = lib.mkOption {
2626
default = pkgs;
27-
defaultText = "`pkgs` (module argument of `perSystem`)";
27+
defaultText = lib.literalMD "`pkgs` (module argument of `perSystem`)";
2828
};
2929
options.flakeFormatter = lib.mkOption {
3030
type = types.bool;

0 commit comments

Comments
 (0)