formula: update caveats documentation.

This commit is contained in:
Mike McQuaid 2019-06-20 11:08:02 +01:00 committed by GitHub
parent 9b0b10ca03
commit 99ed23347a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1014,13 +1014,13 @@ class Formula
@prefix_returns_versioned_prefix = false @prefix_returns_versioned_prefix = false
end end
# Tell the user about any Homebrew-specific caveats or locations regarding # Warn the user about any Homebrew-specific issues or quirks for this package
# this package. These should not contain setup instructions that would apply # These should not contain setup instructions that would apply to installation
# to installation through a different package manager on a different OS. # through a different package manager on a different OS.
# @return [String] # @return [String]
# <pre>def caveats # <pre>def caveats
# <<~EOS # <<~EOS
# Are optional. Something the user should know? # Are optional. Something the user must be warned about?
# EOS # EOS
# end</pre> # end</pre>
# #