docs: add missing descriptions for core module

nix-community · Oct 11, 2023 · 212fcf4 · 212fcf4
1 parent e945481
commit 212fcf4
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/modules/dream2nix/core/env/default.nix b/modules/dream2nix/core/env/default.nix
@@ -15,6 +15,9 @@ in {
       in
         t.attrsOf (t.nullOr (t.oneOf allTypes));
       default = {};
+      description = ''
+        environment variables passed to the build environment
+      '';
     };
   };
 }
diff --git a/modules/dream2nix/core/eval-cache/interface.nix b/modules/dream2nix/core/eval-cache/interface.nix
@@ -14,6 +14,10 @@ in {
       type = t.submodule {
         freeformType = t.anything;
       };
+      description = ''
+        The content of the cached fields.
+        For example if fields.pname is set to true, then content.pname will exist.
+      '';
     };
 
     invalidationFields = l.mkOption {

diff --git a/modules/dream2nix/core/flags/default.nix b/modules/dream2nix/core/flags/default.nix
@@ -44,6 +44,9 @@ in {
     flagsOffered = l.mkOption {
       type = t.attrsOf t.str;
       default = {};
+      description = ''
+        declare flags that can be used to enable/disable features
+      '';
     };
 
     # The flag options generated from `flagsOffered`
@@ -52,6 +55,9 @@ in {
         options = l.mapAttrs (_: mkFlag) config.flagsOffered;
       };
       default = {};
+      description = ''
+        Enable/disable flags declared in `flagsOffered`
+      '';
     };
   };
 }
diff --git a/modules/dream2nix/core/lock/interface.nix b/modules/dream2nix/core/lock/interface.nix
@@ -17,6 +17,10 @@ in {
       type = t.submodule {
         freeformType = t.anything;
       };
+      description = ''
+        The content of the lock file.
+        All fields declared via `lock.fields` are contained pointing to their respective values.
+      '';
     };
 
     fields = l.mkOption {