diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md index 3692c77a61..65f2cc1384 100644 --- a/Library/Homebrew/README.md +++ b/Library/Homebrew/README.md @@ -4,6 +4,6 @@ This is the public API for Homebrew. The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private. -You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide) helpful in creating formulae. +You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://rubystyle.guide) helpful in creating formulae. Good luck! diff --git a/Library/Homebrew/extend/pathname.rb b/Library/Homebrew/extend/pathname.rb index 9d45d5f5ef..258bd0af73 100644 --- a/Library/Homebrew/extend/pathname.rb +++ b/Library/Homebrew/extend/pathname.rb @@ -69,7 +69,7 @@ module DiskUsageExtension end # Homebrew extends Ruby's `Pathname` to make our code more readable. -# @see https://ruby-doc.org/stdlib-1.8.7/libdoc/pathname/rdoc/Pathname.html Ruby's Pathname API +# @see https://ruby-doc.org/stdlib-2.6.3/libdoc/pathname/rdoc/Pathname.html Ruby's Pathname API class Pathname include DiskUsageExtension diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index 9fd75a3197..db2b1e5728 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -39,7 +39,7 @@ require "utils/spdx" # @see Pathname # @see https://www.rubydoc.info/stdlib/fileutils FileUtils # @see https://docs.brew.sh/Formula-Cookbook Formula Cookbook -# @see https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide Ruby Style Guide +# @see https://rubystyle.guide Ruby Style Guide # #
class Wget < Formula
 #   homepage "https://www.gnu.org/software/wget/"
@@ -2374,7 +2374,7 @@ class Formula
     # and you haven't passed or previously used any options on this formula.
     #
     # If you maintain your own repository, you can add your own bottle links.
-    # @see https://docs.brew.sh/Bottles
+    # @see https://docs.brew.sh/Bottles Bottles
     # You can ignore this block entirely if submitting to Homebrew/homebrew-core.
     # It'll be handled for you by the Brew Test Bot.
     #
@@ -2597,6 +2597,7 @@ class Formula
     # to provide multiple embedded patches while making only some of them
     # conditional.
     # 
patch :p0, "..."
+ # @see https://docs.brew.sh/Formula-Cookbook#patches Patches def patch(strip = :p1, src = nil, &block) specs.each { |spec| spec.patch(strip, src, &block) } end @@ -2696,7 +2697,7 @@ class Formula # and foo --version and foo --help are bad tests. # However, a bad test is better than no test at all. # - # See: https://docs.brew.sh/Formula-Cookbook#add-a-test-to-the-formula + # @see https://docs.brew.sh/Formula-Cookbook#add-a-test-to-the-formula Tests # #
(testpath/"test.file").write <<~EOS
     #   writing some test file, if you need to
diff --git a/Library/Homebrew/keg.rb b/Library/Homebrew/keg.rb
index dd244bf6f5..f6e121bb03 100644
--- a/Library/Homebrew/keg.rb
+++ b/Library/Homebrew/keg.rb
@@ -89,7 +89,7 @@ class Keg
   ).map { |dir| HOMEBREW_PREFIX/dir }.sort.uniq.freeze
 
   # Keep relatively in sync with
-  # https://github.com/Homebrew/install/blob/HEAD/install
+  # {https://github.com/Homebrew/install/blob/HEAD/install.sh}
   MUST_EXIST_DIRECTORIES = (MUST_EXIST_SUBDIRECTORIES + [
     HOMEBREW_CELLAR,
   ].sort.uniq).freeze
diff --git a/Library/Homebrew/metafiles.rb b/Library/Homebrew/metafiles.rb
index 5a244e6450..2e4034706d 100644
--- a/Library/Homebrew/metafiles.rb
+++ b/Library/Homebrew/metafiles.rb
@@ -6,7 +6,7 @@
 # @api private
 module Metafiles
   LICENSES = Set.new(%w[copying copyright license licence]).freeze
-  # https://github.com/github/markup#markups
+  # {https://github.com/github/markup#markups}
   EXTENSIONS = Set.new(%w[
                          .adoc .asc .asciidoc .creole .html .markdown .md .mdown .mediawiki .mkdn
                          .org .pod .rdoc .rst .rtf .textile .txt .wiki
diff --git a/Library/Homebrew/os/mac.rb b/Library/Homebrew/os/mac.rb
index 2ed8d45282..bda5e58f2e 100644
--- a/Library/Homebrew/os/mac.rb
+++ b/Library/Homebrew/os/mac.rb
@@ -45,14 +45,14 @@ module OS
     def latest_stable_version
       # TODO: bump version when new macOS is released and also update
       # references in docs/Installation.md and
-      # https://github.com/Homebrew/install/blob/HEAD/install
+      # https://github.com/Homebrew/install/blob/HEAD/install.sh
       Version.new "10.15"
     end
 
     def outdated_release?
       # TODO: bump version when new macOS is released and also update
       # references in docs/Installation.md and
-      # https://github.com/Homebrew/install/blob/HEAD/install
+      # https://github.com/Homebrew/install/blob/HEAD/install.sh
       version < "10.13"
     end
 
@@ -143,9 +143,9 @@ module OS
 
     # See these issues for some history:
     #
-    # - https://github.com/Homebrew/legacy-homebrew/issues/13
-    # - https://github.com/Homebrew/legacy-homebrew/issues/41
-    # - https://github.com/Homebrew/legacy-homebrew/issues/48
+    # - {https://github.com/Homebrew/legacy-homebrew/issues/13}
+    # - {https://github.com/Homebrew/legacy-homebrew/issues/41}
+    # - {https://github.com/Homebrew/legacy-homebrew/issues/48}
     def macports_or_fink
       paths = []
 
diff --git a/Library/Homebrew/os/mac/xquartz.rb b/Library/Homebrew/os/mac/xquartz.rb
index 21bed29170..c056a27529 100644
--- a/Library/Homebrew/os/mac/xquartz.rb
+++ b/Library/Homebrew/os/mac/xquartz.rb
@@ -58,8 +58,7 @@ module OS
         "2.7.11"
       end
 
-      # - https://xquartz.macosforge.org/trac/wiki
-      # - https://xquartz.macosforge.org/trac/wiki/Releases
+      # @see https://www.xquartz.org/releases/index.html
       def latest_version
         "2.7.11"
       end
diff --git a/Library/Homebrew/rubocops/cask/stanza_grouping.rb b/Library/Homebrew/rubocops/cask/stanza_grouping.rb
index 93e5ba21ea..6d17bbb9df 100644
--- a/Library/Homebrew/rubocops/cask/stanza_grouping.rb
+++ b/Library/Homebrew/rubocops/cask/stanza_grouping.rb
@@ -7,8 +7,7 @@ module RuboCop
   module Cop
     module Cask
       # This cop checks that a cask's stanzas are grouped correctly.
-      # See https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order
-      # for more info.
+      # @see https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order
       class StanzaGrouping < Cop
         extend Forwardable
         include CaskHelp
diff --git a/Library/Homebrew/rubocops/cask/stanza_order.rb b/Library/Homebrew/rubocops/cask/stanza_order.rb
index be6af752fa..af044d8b75 100644
--- a/Library/Homebrew/rubocops/cask/stanza_order.rb
+++ b/Library/Homebrew/rubocops/cask/stanza_order.rb
@@ -7,8 +7,7 @@ module RuboCop
   module Cop
     module Cask
       # This cop checks that a cask's stanzas are ordered correctly.
-      # See https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order
-      # for more info.
+      # @see https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order
       class StanzaOrder < Cop
         extend Forwardable
         include CaskHelp