flake: checks: add comments summarizing individual check sections

Individual check sections are clarified using comments rather than local variables to increase expressibility.
trueNAHO · Sep 2, 2024 · bba84d5 · bba84d5
1 parent b061dc2
commit bba84d5
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/flake.nix b/flake.nix
@@ -211,6 +211,7 @@
         pkgs = inputs.nixpkgs.legacyPackages.${system};
       in {
         checks = lib.dotfiles.mergeAttrsUnionOfDisjoint [
+          # This attribute set contains manually declared checks.
           {
             gitHooks = inputs.gitHooks.lib.${system}.run {
               hooks = {
@@ -232,6 +233,8 @@
               src = ./.;
             };
           }
+
+          # This attribute set contains all Home Manager configurations.
           (
             lib.mapAttrs'
             (
@@ -250,16 +253,20 @@
               inputs.self.homeConfigurations
             )
           )
+
+          # This attribute set contains all packages.
+          #
+          # To maintain performance, this attribute set should not contain
+          # composed or aliased packages.
           (
-            # To maintain performance, this set should not contain composed or
-            # aliased packages.
             builtins.removeAttrs
             inputs.self.packages.${system}
             ["checkWithoutStandalone"]
           )
-          # This generates
+
+          # This attribute set contains all
           # inputs.self.checks.<SYSTEM>.standalone-<OPTION>-<VALUE> Home Manager
-          # activation packages from internal module options.
+          # activation packages generated from internal module options.
           (
             builtins.mapAttrs
             (_: value: value.activationPackage)