From 06ebe54ddb1830031265a87239757cd38cf774cc Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 21 Nov 2021 14:30:12 +0100
Subject: [PATCH] Add more descriptions

---
 modules/checks.nix         | 6 ++++++
 modules/devShell.nix       | 6 ++++++
 modules/legacyPackages.nix | 6 ++++++
 modules/packages.nix       | 8 ++++++++
 4 files changed, 26 insertions(+)

diff --git a/modules/checks.nix b/modules/checks.nix
index 5ef468a..1e745dc 100644
--- a/modules/checks.nix
+++ b/modules/checks.nix
@@ -15,6 +15,9 @@ in
       checks = mkOption {
         type = types.lazyAttrsOf (types.lazyAttrsOf types.package);
         default = { };
+        description = ''
+          Derivations to be built by nix flake check.
+        '';
       };
     };
   };
@@ -38,6 +41,9 @@ in
         checks = mkOption {
           type = types.lazyAttrsOf types.package;
           default = { };
+          description = ''
+            Derivations to be built by nix flake check.
+          '';
         };
       };
     };
diff --git a/modules/devShell.nix b/modules/devShell.nix
index 12ca2ac..3567328 100644
--- a/modules/devShell.nix
+++ b/modules/devShell.nix
@@ -15,6 +15,9 @@ in
       devShell = mkOption {
         type = types.lazyAttrsOf types.package;
         default = { };
+        description = ''
+          For each system a derivation that nix develop bases its environment on.
+        '';
       };
     };
   };
@@ -37,6 +40,9 @@ in
       options = {
         devShell = mkOption {
           type = types.nullOr types.package;
+          description = ''
+            A derivation that nix develop bases its environment on.
+          '';
         };
       };
     };
diff --git a/modules/legacyPackages.nix b/modules/legacyPackages.nix
index 7e963c5..4f89151 100644
--- a/modules/legacyPackages.nix
+++ b/modules/legacyPackages.nix
@@ -15,6 +15,9 @@ in
       legacyPackages = mkOption {
         type = types.lazyAttrsOf (types.lazyAttrsOf types.anything);
         default = { };
+        description = ''
+          Per system, an attribute set of anything. This is also used by nix build .#<attrpath>.
+        '';
       };
     };
   };
@@ -38,6 +41,9 @@ in
         legacyPackages = mkOption {
           type = types.lazyAttrsOf types.anything;
           default = { };
+          description = ''
+            An attribute set of anything. This is also used by nix build .#<attrpath>.
+          '';
         };
       };
     };
diff --git a/modules/packages.nix b/modules/packages.nix
index da2c234..622e056 100644
--- a/modules/packages.nix
+++ b/modules/packages.nix
@@ -15,6 +15,10 @@ in
       packages = mkOption {
         type = types.lazyAttrsOf (types.lazyAttrsOf types.package);
         default = { };
+        description = ''
+          Per system an attribute set of packages.
+          nix build .#<name> will build packages.<system>.<name>.
+        '';
       };
     };
   };
@@ -38,6 +42,10 @@ in
         packages = mkOption {
           type = types.lazyAttrsOf types.package;
           default = { };
+          description = ''
+            An attribute set of packages to be built by nix build .#<name>.
+            nix build .#<name> will build packages.<name>.
+          '';
         };
       };
     };