about summary refs log tree commit diff
path: root/nixos/modules/services/monitoring
diff options
context:
space:
mode:
authorBjørn Forsman <bjorn.forsman@gmail.com>2023-10-18 22:59:26 +0200
committerJörg Thalheim <Mic92@users.noreply.github.com>2023-10-20 16:22:40 +0100
commit142074c2a84ea2f018ed729e9ff6ee97c4f022b8 (patch)
treed63ed24230dc4d43156109a6c8cb4d655e921ed3 /nixos/modules/services/monitoring
parentccf848f9dd1ac4fb7f9c9ef595aaca9f6cedd60c (diff)
downloadnixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.tar
nixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.tar.gz
nixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.tar.bz2
nixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.tar.lz
nixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.tar.xz
nixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.tar.zst
nixlib-142074c2a84ea2f018ed729e9ff6ee97c4f022b8.zip
nixos: fix bad mkEnableOption descriptions
Fix descriptions that don't account for (1) the "Whether to enable"
prefix or (2) the automatically added trailing dot.
Diffstat (limited to 'nixos/modules/services/monitoring')
-rw-r--r--nixos/modules/services/monitoring/mackerel-agent.nix6
-rw-r--r--nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix2
2 files changed, 4 insertions, 4 deletions
diff --git a/nixos/modules/services/monitoring/mackerel-agent.nix b/nixos/modules/services/monitoring/mackerel-agent.nix
index 67dc1bc19edd..62a7858500f2 100644
--- a/nixos/modules/services/monitoring/mackerel-agent.nix
+++ b/nixos/modules/services/monitoring/mackerel-agent.nix
@@ -11,10 +11,10 @@ in {
 
     # the upstream package runs as root, but doesn't seem to be strictly
     # necessary for basic functionality
-    runAsRoot = mkEnableOption (lib.mdDoc "Whether to run as root");
+    runAsRoot = mkEnableOption (lib.mdDoc "running as root");
 
     autoRetirement = mkEnableOption (lib.mdDoc ''
-      Whether to automatically retire the host upon OS shutdown.
+      retiring the host upon OS shutdown
     '');
 
     apiKeyFile = mkOption {
@@ -59,7 +59,7 @@ in {
         };
 
         options.diagnostic =
-          mkEnableOption (lib.mdDoc "Collect memory usage for the agent itself");
+          mkEnableOption (lib.mdDoc "collecting memory usage for the agent itself");
       };
     };
   };
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix b/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix
index c98dcd9f64bf..9b7590314936 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix
@@ -11,7 +11,7 @@ in {
     ({ options.warnings = options.warnings; options.assertions = options.assertions; })
   ];
   extraOpts = {
-    verbose = mkEnableOption (lib.mdDoc "Verbose logging mode for prometheus-wireguard-exporter");
+    verbose = mkEnableOption (lib.mdDoc "verbose logging mode for prometheus-wireguard-exporter");
 
     wireguardConfig = mkOption {
       type = with types; nullOr (either path str);