aboutsummaryrefslogtreecommitdiffstats
path: root/Library
diff options
context:
space:
mode:
authorJohn Hawkinson2017-04-09 11:02:05 -0400
committerJohn Hawkinson2017-04-09 15:07:05 -0400
commit31ce953f6911f9ad2e64311b9e0237f448ff3559 (patch)
treecdeaaebea47bbeec14382332ea10be2671db251e /Library
parentd84655efb9dba5840d75e08da5b69f5fd0c56744 (diff)
downloadbrew-31ce953f6911f9ad2e64311b9e0237f448ff3559.tar.bz2
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.
Diffstat (limited to 'Library')
-rw-r--r--Library/Homebrew/formula.rb2
1 files changed, 1 insertions, 1 deletions
diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb
index 523de244d..d544bd668 100644
--- a/Library/Homebrew/formula.rb
+++ b/Library/Homebrew/formula.rb
@@ -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]) }