From 097ef39bab99b0a17599f8c8744bf94242826c8b Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Fri, 14 Aug 2020 01:58:14 +0200
Subject: [PATCH] Add `.rubocop_todo.yml` for documentation.

---
 Library/.rubocop_cask.yml          |  4 ++++
 Library/Homebrew/.rubocop.yml      | 19 +++++++++---------
 Library/Homebrew/.rubocop_todo.yml | 31 ++++++++++++++++++++++++++++++
 3 files changed, 45 insertions(+), 9 deletions(-)
 create mode 100644 Library/Homebrew/.rubocop_todo.yml

diff --git a/Library/.rubocop_cask.yml b/Library/.rubocop_cask.yml
index cc6ccf9a5f..e4c4939a38 100644
--- a/Library/.rubocop_cask.yml
+++ b/Library/.rubocop_cask.yml
@@ -27,5 +27,9 @@ Cask/StanzaOrder:
 # don't want these for casks but re-enabled for Library/Homebrew
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false
diff --git a/Library/Homebrew/.rubocop.yml b/Library/Homebrew/.rubocop.yml
index d517069b81..e280f0f62f 100644
--- a/Library/Homebrew/.rubocop.yml
+++ b/Library/Homebrew/.rubocop.yml
@@ -1,4 +1,6 @@
-inherit_from: ../.rubocop_rspec.yml
+inherit_from:
+  - ../.rubocop_rspec.yml
+  - .rubocop_todo.yml
 
 AllCops:
   Include:
@@ -105,12 +107,6 @@ Naming/MethodParameterName:
 Style/AccessModifierDeclarations:
   Enabled: false
 
-# make rspec formatting more flexible
-Style/BlockDelimiters:
-  Exclude:
-    - '**/*_spec.rb'
-    - '**/shared_examples/**/*.rb'
-
 # don't group nicely documented or private attr_readers
 Style/AccessorGrouping:
   Exclude:
@@ -121,11 +117,16 @@ Style/AccessorGrouping:
     - 'system_command.rb'
     - 'tap.rb'
 
+# make rspec formatting more flexible
+Style/BlockDelimiters:
+  Exclude:
+    - '**/*_spec.rb'
+    - '**/shared_examples/**/*.rb'
+
 # document our public APIs
 Style/Documentation:
   Enabled: true
-  Include:
-    - 'formula.rb'
+
 Style/DocumentationMethod:
   Enabled: true
   Include:
diff --git a/Library/Homebrew/.rubocop_todo.yml b/Library/Homebrew/.rubocop_todo.yml
new file mode 100644
index 0000000000..a74f62002a
--- /dev/null
+++ b/Library/Homebrew/.rubocop_todo.yml
@@ -0,0 +1,31 @@
+Style/Documentation:
+  Exclude:
+    - 'compat/**/*.rb'
+    - 'extend/**/*.rb'
+    - 'cmd/**/*.rb'
+    - 'dev-cmd/**/*.rb'
+    - 'test/**/*.rb'
+    - 'cask/macos.rb'
+    - 'cli/args.rb'
+    - 'cli/parser.rb'
+    - 'download_strategy.rb'
+    - 'global.rb'
+    - 'keg_relocate.rb'
+    - 'os/linux/global.rb'
+    - 'os/mac/architecture_list.rb'
+    - 'os/mac/keg.rb'
+    - 'reinstall.rb'
+    - 'software_spec.rb'
+    - 'upgrade.rb'
+    - 'utils.rb'
+    - 'utils/fork.rb'
+    - 'utils/gems.rb'
+    - 'utils/notability.rb'
+    - 'utils/popen.rb'
+    - 'utils/pypi.rb'
+    - 'utils/shebang.rb'
+    - 'utils/shell.rb'
+    - 'utils/spdx.rb'
+    - 'utils/livecheck_formula.rb'
+    - 'utils/repology.rb'
+    - 'version.rb'