Merge pull request #8397 from reitermarkus/document-options

Refactor and document `Options`.

Library/Homebrew/cmd/info.rb

@@ -234,7 +234,7 @@ module Homebrew
 
     if !f.options.empty? || f.head || f.devel
       ohai "Options"
-      Homebrew.dump_options_for_formula f
+      Options.dump_for_formula f
     end
 
     caveats = Caveats.new(f)

Library/Homebrew/cmd/options.rb

@@ -80,7 +80,7 @@ module Homebrew
         puts f.options.as_flags.sort * " "
       else
         puts f.full_name if formulae.length > 1
-        dump_options_for_formula f
+        Options.dump_for_formula f
         puts
       end
     end

Library/Homebrew/options.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# A formula option.
+#
+# @api private
 class Option
   attr_reader :name, :description, :flag
 
@@ -33,6 +36,9 @@ class Option
   end
 end
 
+# A deprecated formula option.
+#
+# @api private
 class DeprecatedOption
   attr_reader :old, :current
 
@@ -55,6 +61,9 @@ class DeprecatedOption
   alias eql? ==
 end
 
+# A collection of formula options.
+#
+# @api private
 class Options
   include Enumerable
 
@@ -112,12 +121,8 @@ class Options
   def inspect
     "#<#{self.class.name}: #{to_a.inspect}>"
   end
-end
 
-module Homebrew
+  def self.dump_for_formula(f)
-  module_function
-
-  def dump_options_for_formula(f)
     f.options.sort_by(&:flag).each do |opt|
       puts "#{opt.flag}\n\t#{opt.description}"
     end