From 99ed23347abb7a13af38e5af52487d36975550c3 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Thu, 20 Jun 2019 11:08:02 +0100 Subject: [PATCH] formula: update caveats documentation. --- Library/Homebrew/formula.rb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index 6a8bababe4..3e22bd8d11 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -1014,13 +1014,13 @@ class Formula @prefix_returns_versioned_prefix = false end - # Tell the user about any Homebrew-specific caveats or locations regarding - # this package. These should not contain setup instructions that would apply - # to installation through a different package manager on a different OS. + # Warn the user about any Homebrew-specific issues or quirks for this package + # These should not contain setup instructions that would apply to installation + # through a different package manager on a different OS. # @return [String] #
def caveats
   #   <<~EOS
-  #     Are optional. Something the user should know?
+  #     Are optional. Something the user must be warned about?
   #   EOS
   # end
#