Document rubocops/shared modules.

2020-08-26 02:52:48 +02:00 · 2020-08-26 02:52:48 +02:00 · d5ba5cb8f8
commit d5ba5cb8f8
parent 7e2e5bf388
2 changed files with 5 additions and 0 deletions
--- 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

--- 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