modules: better document options

4 files changed, 12 insertions, 8 deletions

diff --git a/modules/nixos/server/mixins/acme.nix b/modules/nixos/server/mixins/acme.nix
index e809ad4..39166f2 100644
--- a/modules/nixos/server/mixins/acme.nix
+++ b/modules/nixos/server/mixins/acme.nix
@@ -11,11 +11,12 @@ in
   options.server.mixins.acme = {
     enable = lib.mkEnableOption "ACME mixin";
 
-    manageSecrets = lib.mkEnableOption "automatic secrets management" // {
+    manageSecrets = lib.mkEnableOption "automatic management of secrets" // {
       default = config.traits.secrets.enable;
+      defaultText = lib.literalExpression "config.traits.secrets.enable";
     };
 
-    useDns = lib.mkEnableOption "the usage of Cloudflare to obtain certs" // {
+    useDns = lib.mkEnableOption "the use of Cloudflare to obtain certs" // {
       default = true;
     };
   };
diff --git a/modules/nixos/server/mixins/cloudflared.nix b/modules/nixos/server/mixins/cloudflared.nix
index f781150..43da9de 100644
--- a/modules/nixos/server/mixins/cloudflared.nix
+++ b/modules/nixos/server/mixins/cloudflared.nix
@@ -14,14 +14,16 @@ in
     tunnelName = lib.mkOption {
       type = lib.types.str;
       default = "${config.networking.hostName}-nginx";
-      example = lib.literalExpression "my-tunnel";
-      description = lib.mdDoc ''
+      defaultText = lib.literalExpression "\${config.networking.hostName}-nginx";
+      example = "my-tunnel";
+      description = ''
         Name of the default tunnel being created
       '';
     };
 
-    manageSecrets = lib.mkEnableOption "automatic secrets management" // {
+    manageSecrets = lib.mkEnableOption "automatic management of secrets" // {
       default = config.traits.secrets.enable;
+      defaultText = lib.literalExpression "config.traits.secrets.enable";
     };
   };
 
diff --git a/modules/nixos/server/mixins/hercules.nix b/modules/nixos/server/mixins/hercules.nix
index 49ba46d..7d0b1fb 100644
--- a/modules/nixos/server/mixins/hercules.nix
+++ b/modules/nixos/server/mixins/hercules.nix
@@ -10,9 +10,10 @@ let
 in
 {
   options.server.mixins.hercules-ci = {
-    enable = lib.mkEnableOption "hercules-ci mixin";
-    manageSecrets = lib.mkEnableOption "automatic secrets management" // {
+    enable = lib.mkEnableOption "Hercules CI mixin";
+    manageSecrets = lib.mkEnableOption "automatic management of secrets" // {
       default = config.traits.secrets.enable;
+      defaultText = lib.literalExpression "config.traits.secrets.enable";
     };
   };
 
diff --git a/modules/nixos/server/mixins/nginx.nix b/modules/nixos/server/mixins/nginx.nix
index 11306a2..e3cc47a 100644
--- a/modules/nixos/server/mixins/nginx.nix
+++ b/modules/nixos/server/mixins/nginx.nix
@@ -4,7 +4,7 @@ let
 in
 {
   options.server.mixins.nginx = {
-    enable = lib.mkEnableOption "nginx mixin";
+    enable = lib.mkEnableOption "NGINX mixin";
   };
 
   config = lib.mkIf cfg.enable {