From d5ba5cb8f8bf6f3f091f5707f96c47348491c9e1 Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Wed, 26 Aug 2020 02:52:48 +0200
Subject: [PATCH] Document `rubocops/shared` modules.

---
 Library/Homebrew/rubocops/shared/desc_helper.rb      | 2 ++
 Library/Homebrew/rubocops/shared/helper_functions.rb | 3 +++
 2 files changed, 5 insertions(+)

diff --git a/Library/Homebrew/rubocops/shared/desc_helper.rb b/Library/Homebrew/rubocops/shared/desc_helper.rb
index 3ed62a036b..80092a8df7 100644
--- a/Library/Homebrew/rubocops/shared/desc_helper.rb
+++ b/Library/Homebrew/rubocops/shared/desc_helper.rb
@@ -5,6 +5,8 @@ require "rubocops/shared/helper_functions"
 module RuboCop
   module Cop
     # This module performs common checks the `desc` field in both Formulae and Casks.
+    #
+    # @api private
     module DescHelper
       include HelperFunctions
 
diff --git a/Library/Homebrew/rubocops/shared/helper_functions.rb b/Library/Homebrew/rubocops/shared/helper_functions.rb
index a5e893c6ae..8b7388f94c 100644
--- a/Library/Homebrew/rubocops/shared/helper_functions.rb
+++ b/Library/Homebrew/rubocops/shared/helper_functions.rb
@@ -2,6 +2,9 @@
 
 module RuboCop
   module Cop
+    # Helper functions for cops.
+    #
+    # @api private
     module HelperFunctions
       include RangeHelp