formula: conflicts_with doc: give realistic :because

The documentation should help a developer understand what the
parameter is for.  "stupid example" doesn't cut it.
This commit is contained in:
John Hawkinson 2017-04-09 11:02:05 -04:00
parent d84655efb9
commit 31ce953f69

View File

@ -2340,7 +2340,7 @@ class Formula
end
# If this formula conflicts with another one.
# <pre>conflicts_with "imagemagick", :because => "because this is just a stupid example"</pre>
# <pre>conflicts_with "imagemagick", :because => "because both install 'convert' binaries"</pre>
def conflicts_with(*names)
opts = names.last.is_a?(Hash) ? names.pop : {}
names.each { |name| conflicts << FormulaConflict.new(name, opts[:because]) }