From 69a0e3fb6190614513b26ce08db3506f8dc404ae Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Wed, 26 Aug 2020 02:24:22 +0200 Subject: [PATCH] Document `FormulaAudit::ComponentsRedundancy`. --- Library/Homebrew/rubocops/components_redundancy.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Library/Homebrew/rubocops/components_redundancy.rb b/Library/Homebrew/rubocops/components_redundancy.rb index d0d6298d50..695971e0cd 100644 --- a/Library/Homebrew/rubocops/components_redundancy.rb +++ b/Library/Homebrew/rubocops/components_redundancy.rb @@ -5,13 +5,14 @@ require "rubocops/extend/formula" module RuboCop module Cop module FormulaAudit - # This cop checks if redundant components are present and other component errors. + # This cop checks if redundant components are present and for other component errors. # # - `url|checksum|mirror` should be inside `stable` block # - `head` and `head do` should not be simultaneously present # - `bottle :unneeded`/`:disable` and `bottle do` should not be simultaneously present # - `stable do` should not be present without a `head` or `devel` spec - + # + # @api private class ComponentsRedundancy < FormulaCop HEAD_MSG = "`head` and `head do` should not be simultaneously present" BOTTLE_MSG = "`bottle :modifier` and `bottle do` should not be simultaneously present"