Improve brew-bundle module documentation

1 files changed, 9 insertions, 11 deletions

diff --git a/modules/programs/brew-bundle.nix b/modules/programs/brew-bundle.nix
index 209cd3d..33e07b3 100644
--- a/modules/programs/brew-bundle.nix
+++ b/modules/programs/brew-bundle.nix
@@ -38,18 +38,17 @@ in
 {
   options.programs.brew-bundle = {
     enable = mkEnableOption ''
-      Enables configuring your Brewfile, and installing/updating the formulas therein via
+      configuring your Brewfile, and installing/updating the formulas therein via
       the <command>brew bundle</command> command, using <command>nix-darwin</command>.
 
       Note that enabling this option does not install Homebrew. See the Homebrew website for
-      installation instructions:
-      https://brew.sh
+      installation instructions: https://brew.sh
     '';
 
     cleanupType = mkOption {
       type = with types; enum [ "none" "uninstall" "zap" ];
-      default = "uninstall";
-      example = "none";
+      default = "none";
+      example = "uninstall";
       description = ''
         This option manages what happens to formulas installed by Homebrew, that aren't present in
         the Brewfile generated by this module.
@@ -128,8 +127,8 @@ in
       description = ''
         Applications to install from Mac App Store using <command>mas</command>.
 
-        When this option is set to a non-empty list, <literal>"mas"</literal> is automatically added
-        to <option>programs.brew-bundle.brews</option>.
+        When this option is used, <literal>"mas"</literal> is automatically added to
+        <option>programs.brew-bundle.brews</option>.
 
         Note that you need to be signed into the Mac App Store for <command>mas</command> to
         successfully install and upgrade applications, and that unfortunately apps removed from this
@@ -137,8 +136,7 @@ in
         <option>programs.brew-bundle.cleanupType</option> is set to <literal>"uninstall"</literal>
         or <literal>"zap"</literal> (this is currently a limitation of Homebrew Bundle).
 
-        For more information on <command>mas</command> see:
-        https://github.com/mas-cli/mas
+        For more information on <command>mas</command> see: https://github.com/mas-cli/mas
       '';
     };
 
@@ -149,8 +147,8 @@ in
       description = ''
         Docker images to install using <command>whalebrew</command>.
 
-        When this option is set to a non-empty list, <literal>"whalebrew"</literal> is automatically
-        added to <option>programs.brew-bundle.brews</option>.
+        When this option is used, <literal>"whalebrew"</literal> is automatically added to
+        <option>programs.brew-bundle.brews</option>.
 
         For more information on <command>whalebrew</command> see:
         https://github.com/whalebrew/whalebrew