cmd+dev-cmd: adjust description line breaks

Use to distinguish additional notes from initial explanation and usage info
Homebrew · Sep 9, 2023 · 76e8b46 · 76e8b46
1 parent 2503337
commit 76e8b46
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 14 deletions.
diff --git a/Library/Homebrew/cmd/doctor.rb b/Library/Homebrew/cmd/doctor.rb
@@ -11,10 +11,11 @@ def self.doctor_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
         Check your system for potential problems. Will exit with a non-zero status
-        if any potential problems are found. Please note that these warnings are just
-        used to help the Homebrew maintainers with debugging if you file an issue. If
-        everything you use Homebrew for is working fine: please don't worry or file
-        an issue; just ignore this.
+        if any potential problems are found.
+
+        Please note that these warnings are just used to help the Homebrew maintainers
+        with debugging if you file an issue. If everything you use Homebrew for
+        is working fine: please don't worry or file an issue; just ignore this.
       EOS
       switch "--list-checks",
              description: "List all audit methods, which can be run individually " \

diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb
@@ -25,7 +25,6 @@ def info_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
         Display brief statistics for your Homebrew installation.
-
         If a <formula> or <cask> is provided, show summary of information about it.
       EOS
       switch "--analytics",

diff --git a/Library/Homebrew/cmd/link.rb b/Library/Homebrew/cmd/link.rb
@@ -12,9 +12,9 @@ module Homebrew
   def link_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
-        Symlink all of <formula>'s installed files into Homebrew's prefix. This
-        is done automatically when you install formulae but can be useful for DIY
-        installations.
+        Symlink all of <formula>'s installed files into Homebrew's prefix.
+        This is done automatically when you install formulae but can be useful
+        for manual installations.
       EOS
       switch "--overwrite",
              description: "Delete files that already exist in the prefix while linking."

diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb
@@ -14,7 +14,6 @@ def list_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
         List all installed formulae and casks.
-
         If <formula> is provided, summarise the paths within its current keg.
         If <cask> is provided, list its artifacts.
       EOS

diff --git a/Library/Homebrew/cmd/tap-info.rb b/Library/Homebrew/cmd/tap-info.rb
@@ -11,7 +11,6 @@ def tap_info_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
         Show detailed information about one or more <tap>s.
-
         If no <tap> names are provided, display brief statistics for all installed taps.
       EOS
       switch "--installed",

diff --git a/Library/Homebrew/cmd/tap.rb b/Library/Homebrew/cmd/tap.rb
@@ -12,7 +12,6 @@ def tap_args
       usage_banner "`tap` [<options>] [<user>`/`<repo>] [<URL>]"
       description <<~EOS
         Tap a formula repository.
-
         If no arguments are provided, list all installed taps.
 
         With <URL> unspecified, tap a formula repository from GitHub using HTTPS.

diff --git a/Library/Homebrew/dev-cmd/livecheck.rb b/Library/Homebrew/dev-cmd/livecheck.rb
@@ -14,7 +14,6 @@ def livecheck_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
         Check for newer versions of formulae and/or casks from upstream.
-
         If no formula or cask argument is passed, the list of formulae and
         casks to check is taken from `HOMEBREW_LIVECHECK_WATCHLIST` or
         `~/.homebrew/livecheck_watchlist.txt`.

diff --git a/Library/Homebrew/dev-cmd/release.rb b/Library/Homebrew/dev-cmd/release.rb
@@ -11,13 +11,12 @@ def release_args
     Homebrew::CLI::Parser.new do
       description <<~EOS
         Create a new draft Homebrew/brew release with the appropriate version number and release notes.
+        Requires write access to the Homebrew/brew repository.
 
         By default, `brew release` will bump the patch version number. Pass
         `--major` or `--minor` to bump the major or minor version numbers, respectively.
         The command will fail if the previous major or minor release was made less than
         one month ago.
-
-        Requires write access to the Homebrew/brew repository.
       EOS
       switch "--major",
              description: "Create a major release."