Merge pull request #8494 from reitermarkus/document-shared-audits

Document `SharedAudits`.

Library/Homebrew/.rubocop_todo.yml

@@ -20,7 +20,6 @@ Style/Documentation:
     - 'utils.rb'
     - 'utils/fork.rb'
     - 'utils/gems.rb'
-    - 'utils/notability.rb'
     - 'utils/popen.rb'
     - 'utils/shell.rb'
     - 'utils/livecheck_formula.rb'

Library/Homebrew/cask/audit.rb

@@ -5,7 +5,7 @@ require "cask/download"
 require "digest"
 require "utils/curl"
 require "utils/git"
-require "utils/notability"
+require "utils/shared_audits"
 
 module Cask
   # Audit a cask for various problems.

Library/Homebrew/dev-cmd/audit.rb

@@ -3,7 +3,7 @@
 require "formula"
 require "formula_versions"
 require "utils/curl"
-require "utils/notability"
+require "utils/shared_audits"
 require "utils/spdx"
 require "extend/ENV"
 require "formula_cellar_checks"

Library/Homebrew/sorbet/files.yaml

@@ -902,7 +902,7 @@ true:
   - ./utils/bottles.rb
   - ./utils/inreplace.rb
   - ./utils/link.rb
-  - ./utils/notability.rb
+  - ./utils/shared_audits.rb
   - ./utils/shebang.rb
   - ./utils/shell.rb
   - ./utils/spdx.rb

Library/Homebrew/utils/shared_audits.rb

@@ -2,6 +2,9 @@
 
 require "utils/curl"
 
+# Auditing functions for rules common to both casks and formulae.
+#
+# @api private
 module SharedAudits
   module_function