From 7630cee8e1df5a6d6deea3cd46010e3a5f6de37f Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Wed, 26 Aug 2020 03:00:56 +0200
Subject: [PATCH] Document `FormulaAudit::Urls`.

---
 Library/Homebrew/rubocops/urls.rb | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Library/Homebrew/rubocops/urls.rb b/Library/Homebrew/rubocops/urls.rb
index 8f6a3aefda..ca6a22d1ec 100644
--- a/Library/Homebrew/rubocops/urls.rb
+++ b/Library/Homebrew/rubocops/urls.rb
@@ -6,6 +6,8 @@ module RuboCop
   module Cop
     module FormulaAudit
       # This cop audits URLs and mirrors in Formulae.
+      #
+      # @api private
       class Urls < FormulaCop
         # These are parts of URLs that look like binaries but actually aren't.
         NOT_A_BINARY_URL_PREFIX_ALLOWLIST = %w[
@@ -285,6 +287,9 @@ module RuboCop
         end
       end
 
+      # This cop makes sure that the correct format for PyPi URLs is used.
+      #
+      # @api private
       class PyPiUrls < FormulaCop
         def audit_formula(_node, _class_node, _parent_class_node, body_node)
           urls = find_every_func_call_by_name(body_node, :url)
-- 
GitLab