docs: Use defaultText

This is a bit more useful and passes the stricter rules I apply in flake-parts docs.
hercules-ci · Jan 2, 2025 · e17a6a6 · e17a6a6
1 parent 8d13e1f
commit e17a6a6
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/src/modules/outputs.nix b/src/modules/outputs.nix
@@ -8,6 +8,14 @@
           ncdu = pkgs.ncdu;
         };
       };
+      defaultText = lib.literalExpression ''
+        {
+          git = pkgs.git;
+          foo = {
+            ncdu = pkgs.ncdu;
+          };
+        }
+      '';
       description = ''
         Nix outputs for `devenv build` consumption.
       '';

diff --git a/src/modules/scripts.nix b/src/modules/scripts.nix
@@ -18,11 +18,13 @@ let
           type = types.package;
           description = "The package to use to run the script.";
           default = pkgs.bash;
+          defaultText = lib.literalExpression "pkgs.bash";
         };
         binary = lib.mkOption {
           type = types.str;
           description = "Override the binary name if it doesn't match package name";
           default = config.package.pname;
+          defaultText = lib.literalExpression "config.package.pname";
         };
         description = lib.mkOption {
           type = types.str;

diff --git a/src/modules/tasks.nix b/src/modules/tasks.nix
@@ -31,10 +31,12 @@ let
             type = types.str;
             description = "Override the binary name if it doesn't match package name";
             default = config.package.pname;
+            defaultText = lib.literalExpression "config.package.pname";
           };
           package = lib.mkOption {
             type = types.package;
             default = pkgs.bash;
+            defaultText = lib.literalExpression "pkgs.bash";
             description = "Package to install for this task.";
           };
           command = lib.mkOption {

diff --git a/src/modules/top-level.nix b/src/modules/top-level.nix
@@ -70,6 +70,7 @@ in
       type = types.package;
       description = "The stdenv to use for the developer environment.";
       default = pkgs.stdenv;
+      defaultText = lib.literalExpression "pkgs.stdenv";
     };
 
     unsetEnvVars = lib.mkOption {