From 18a69b660e1e915eda4063826f0dbe92f613f915 Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Wed, 26 Aug 2020 09:42:39 +0200
Subject: [PATCH] Document `SharedAudits`.
---
Library/Homebrew/.rubocop_todo.yml | 1 -
Library/Homebrew/cask/audit.rb | 2 +-
Library/Homebrew/dev-cmd/audit.rb | 2 +-
Library/Homebrew/sorbet/files.yaml | 2 +-
Library/Homebrew/utils/{notability.rb => shared_audits.rb} | 3 +++
5 files changed, 6 insertions(+), 4 deletions(-)
rename Library/Homebrew/utils/{notability.rb => shared_audits.rb} (97%)
diff --git a/Library/Homebrew/.rubocop_todo.yml b/Library/Homebrew/.rubocop_todo.yml
index 8029d48cff..abecfb8207 100644
--- a/Library/Homebrew/.rubocop_todo.yml
+++ b/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/shebang.rb'
- 'utils/shell.rb'
diff --git a/Library/Homebrew/cask/audit.rb b/Library/Homebrew/cask/audit.rb
index 70f5d364cc..e1702e43c7 100644
--- a/Library/Homebrew/cask/audit.rb
+++ b/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.
diff --git a/Library/Homebrew/dev-cmd/audit.rb b/Library/Homebrew/dev-cmd/audit.rb
index 7f6a2e2f81..43cb933363 100644
--- a/Library/Homebrew/dev-cmd/audit.rb
+++ b/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"
diff --git a/Library/Homebrew/sorbet/files.yaml b/Library/Homebrew/sorbet/files.yaml
index 9ff6a3ac49..a506566510 100644
--- a/Library/Homebrew/sorbet/files.yaml
+++ b/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
diff --git a/Library/Homebrew/utils/notability.rb b/Library/Homebrew/utils/shared_audits.rb
similarity index 97%
rename from Library/Homebrew/utils/notability.rb
rename to Library/Homebrew/utils/shared_audits.rb
index 86e801202c..7e13fe0afc 100644
--- a/Library/Homebrew/utils/notability.rb
+++ b/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
--
GitLab