summary refs log tree commit diff
path: root/nixos/modules/services/monitoring/prometheus/exporters/flow.nix
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-05 19:39:00 +0200
committerpennae <github@quasiparticle.net>2022-08-06 20:39:12 +0200
commit087472b1e5230ffc8ba642b1e4f9218adf4634a2 (patch)
treeba5c8e457072dce9aa13a92f26bb7e6a47d45776 /nixos/modules/services/monitoring/prometheus/exporters/flow.nix
parent423545fe4865d126e86721ba30da116e29c65004 (diff)
downloadnixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.tar
nixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.tar.gz
nixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.tar.bz2
nixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.tar.lz
nixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.tar.xz
nixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.tar.zst
nixpkgs-087472b1e5230ffc8ba642b1e4f9218adf4634a2.zip
nixos/*: automatically convert option docs
Diffstat (limited to 'nixos/modules/services/monitoring/prometheus/exporters/flow.nix')
-rw-r--r--nixos/modules/services/monitoring/prometheus/exporters/flow.nix8
1 files changed, 4 insertions, 4 deletions
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/flow.nix b/nixos/modules/services/monitoring/prometheus/exporters/flow.nix
index b85e5461f21..81099aaf170 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/flow.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/flow.nix
@@ -10,19 +10,19 @@ in {
     brokers = mkOption {
       type = types.listOf types.str;
       example = literalExpression ''[ "kafka.example.org:19092" ]'';
-      description = "List of Kafka brokers to connect to.";
+      description = lib.mdDoc "List of Kafka brokers to connect to.";
     };
 
     asn = mkOption {
       type = types.ints.positive;
       example = 65542;
-      description = "The ASN being monitored.";
+      description = lib.mdDoc "The ASN being monitored.";
     };
 
     partitions = mkOption {
       type = types.listOf types.int;
       default = [];
-      description = ''
+      description = lib.mdDoc ''
         The number of the partitions to consume, none means all.
       '';
     };
@@ -30,7 +30,7 @@ in {
     topic = mkOption {
       type = types.str;
       example = "pmacct.acct";
-      description = "The Kafka topic to consume from.";
+      description = lib.mdDoc "The Kafka topic to consume from.";
     };
   };