From aa4bcc61a41fcb419a44bc521605ba6ba33e847b Mon Sep 17 00:00:00 2001
From: ahuston-0 <aliceghuston@gmail.com>
Date: Mon, 20 May 2024 01:22:45 -0400
Subject: [PATCH] comment the shell construction

Signed-off-by: ahuston-0 <aliceghuston@gmail.com>
---
 shell.nix | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/shell.nix b/shell.nix
index 180e359..4411adc 100644
--- a/shell.nix
+++ b/shell.nix
@@ -10,10 +10,14 @@ forEachSystem (
   let
     inherit (inputs) nixpkgs sops-nix;
     pkgs = nixpkgs.legacyPackages.${system};
+
+    # construct the shell provided by pre-commit for running hooks
     pre-commit = pkgs.mkShell {
       inherit (checks.${system}.pre-commit-check) shellHook;
       buildInputs = checks.${system}.pre-commit-check.enabledPackages;
     };
+
+    # construct a shell for importing sops keys (also provides the sops binary)
     sops = pkgs.mkShell {
       sopsPGPKeyDirs = [ "./keys" ];
       packages = [
@@ -21,6 +25,8 @@ forEachSystem (
         sops-nix.packages.${system}.sops-import-keys-hook
       ];
     };
+
+    # constructs a custom shell with commonly used utilities
     rad-dev = pkgs.mkShell {
       packages = with pkgs; [
         deadnix