docs: improve description of extraSpecialArgs

CardboardTurkey · Nov 13, 2021 · 39c5c73 · 39c5c73
1 parent be1ad30
commit 39c5c73
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -345,6 +345,9 @@ as follows:
             home-manager.useGlobalPkgs = true;
             home-manager.useUserPackages = true;
             home-manager.users.jdoe = import ./home.nix;
+
+            # Optionally, use home-manager.extraSpecialArgs to pass
+            # arguments to home.nix
           }
         ];
       };

diff --git a/nix-darwin/default.nix b/nix-darwin/default.nix
@@ -63,8 +63,10 @@ in
       extraSpecialArgs = mkOption {
         type = types.attrs;
         default = { };
+        example = literalExpression "{ inherit emacs-overlay; }";
         description = ''
-          Extra <literal>specialArgs</literal> passed to Home Manager.
+          Extra <literal>specialArgs</literal> passed to Home Manager. This
+          option can be used to pass additional arguments to all modules.
         '';
       };
 

diff --git a/nixos/default.nix b/nixos/default.nix
@@ -74,8 +74,10 @@ in {
       extraSpecialArgs = mkOption {
         type = types.attrs;
         default = { };
+        example = literalExpression "{ inherit emacs-overlay; }";
         description = ''
-          Extra <literal>specialArgs</literal> passed to Home Manager.
+          Extra <literal>specialArgs</literal> passed to Home Manager. This
+          option can be used to pass additional arguments to all modules.
         '';
       };