Update documentation for Dependency.expand

This commit is contained in:
Jack Nagel 2013-01-30 22:54:39 -06:00
parent 1408610b81
commit c5f73a01be

View File

@ -54,11 +54,11 @@ class Dependency
tags << 'universal' if to_formula.build.has_option? 'universal'
end
# Expand the dependencies of f recursively, optionally yielding
# [f, dep] to allow callers to apply arbitrary filters to the list.
# The default filter, which is used when a block is not supplied,
# omits optionals and recommendeds based on what the dependent has
# asked for.
# Expand the dependencies of dependent recursively, optionally yielding
# [dependent, dep] pairs to allow callers to apply arbitrary filters to
# the list.
# The default filter, which is applied when a block is not given, omits
# optionals and recommendeds based on what the dependent has asked for.
def self.expand(dependent, &block)
dependent.deps.map do |dep|
prune = catch(:prune) do
@ -75,7 +75,7 @@ class Dependency
end.flatten.compact.uniq
end
# Used to prune dependencies when calling expand_dependencies with a block.
# Used to prune dependencies when calling expand with a block.
def self.prune
throw(:prune, true)
end