From c975ff98a0734b40475b25040fdd198a187d5e7e Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Tue, 18 Aug 2020 03:02:33 +0200 Subject: [PATCH] Document `Requirement`. --- Library/Homebrew/requirement.rb | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Library/Homebrew/requirement.rb b/Library/Homebrew/requirement.rb index 693c749a0d..d4bb330119 100644 --- a/Library/Homebrew/requirement.rb +++ b/Library/Homebrew/requirement.rb @@ -6,8 +6,10 @@ require "dependencies" require "build_environment" # A base class for non-formula requirements needed by formulae. -# A "fatal" requirement is one that will fail the build if it is not present. -# By default, Requirements are non-fatal. +# A fatal requirement is one that will fail the build if it is not present. +# By default, requirements are non-fatal. +# +# @api private class Requirement include Dependable @@ -162,7 +164,7 @@ class Requirement return @satisfied if options.nil? && !block_given? options = {} if options.nil? - @satisfied = Requirement::Satisfier.new(options, &block) + @satisfied = Satisfier.new(options, &block) end def env(*settings, &block) @@ -174,6 +176,7 @@ class Requirement end end + # Helper class for evaluating whether a requirement is satisfied. class Satisfier def initialize(options, &block) case options @@ -201,6 +204,7 @@ class Requirement end end end + private_constant :Satisfier class << self # Expand the requirements of dependent recursively, optionally yielding