Document FormulaAudit::KegOnly.

2020-08-26 02:33:38 +02:00 · 2020-08-26 02:33:38 +02:00 · 8e55d7fde2
commit 8e55d7fde2
parent 7185e4c9a7
1 changed files with 3 additions and 0 deletions
--- a/Library/Homebrew/rubocops/keg_only.rb
+++ b/Library/Homebrew/rubocops/keg_only.rb
@ -5,6 +5,9 @@ require "rubocops/extend/formula"
 module RuboCop
  module Cop
    module FormulaAudit
+      # This cop makes sure that a `keg_only` reason has the correct format.
+      #
+      # @api private
      class KegOnly < FormulaCop
        def audit_formula(_node, _class_node, _parent_class_node, body_node)
          keg_only_node = find_node_method_by_name(body_node, :keg_only)