From f2ce6489b2ad875a9f5f828334fcefb4f8ef3822 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Thu, 22 Feb 2018 19:46:58 +0000 Subject: Use more docs.brew.sh short links These are nicer on the eyes. --- Library/Homebrew/README.md | 2 +- Library/Homebrew/cmd/analytics.rb | 2 +- Library/Homebrew/cmd/help.rb | 2 +- Library/Homebrew/cmd/info.rb | 2 +- Library/Homebrew/cmd/tap-info.rb | 2 +- Library/Homebrew/cmd/update-report.rb | 2 +- Library/Homebrew/dev-cmd/create.rb | 2 +- Library/Homebrew/formula.rb | 4 ++-- Library/Homebrew/manpages/brew.1.md.erb | 4 ++-- Library/Homebrew/missing_formula.rb | 2 +- Library/Homebrew/os.rb | 2 +- Library/Homebrew/utils/analytics.rb | 2 +- 12 files changed, 14 insertions(+), 14 deletions(-) (limited to 'Library/Homebrew') diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md index 681bb9288..e0e961373 100644 --- a/Library/Homebrew/README.md +++ b/Library/Homebrew/README.md @@ -3,6 +3,6 @@ This is the (partially) documented 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.html) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae. +You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae. Good luck! diff --git a/Library/Homebrew/cmd/analytics.rb b/Library/Homebrew/cmd/analytics.rb index 0985f00b8..0f56cd675 100644 --- a/Library/Homebrew/cmd/analytics.rb +++ b/Library/Homebrew/cmd/analytics.rb @@ -1,6 +1,6 @@ #: * `analytics` [`state`]: #: Display anonymous user behaviour analytics state. -#: Read more at . +#: Read more at . #: #: * `analytics` (`on`|`off`): #: Turn on/off Homebrew's analytics. diff --git a/Library/Homebrew/cmd/help.rb b/Library/Homebrew/cmd/help.rb index c85916f9b..c85b92124 100644 --- a/Library/Homebrew/cmd/help.rb +++ b/Library/Homebrew/cmd/help.rb @@ -16,7 +16,7 @@ HOMEBREW_HELP = <<~EOS.freeze Developers: brew create [URL [--no-fetch]] brew edit [FORMULA...] - https://docs.brew.sh/Formula-Cookbook.html + https://docs.brew.sh/Formula-Cookbook Further help: man brew diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index 1eb9fe9fe..27f719c57 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -17,7 +17,7 @@ #: information on all installed formulae. #: #: See the docs for examples of using the JSON output: -#: +#: require "missing_formula" require "caveats" diff --git a/Library/Homebrew/cmd/tap-info.rb b/Library/Homebrew/cmd/tap-info.rb index 3d995f4bc..26daa1a8a 100644 --- a/Library/Homebrew/cmd/tap-info.rb +++ b/Library/Homebrew/cmd/tap-info.rb @@ -13,7 +13,7 @@ #: Pass `--installed` to get information on installed taps. #: #: See the docs for examples of using the JSON output: -#: +#: require "tap" diff --git a/Library/Homebrew/cmd/update-report.rb b/Library/Homebrew/cmd/update-report.rb index 055c55a84..2c4d3de0c 100644 --- a/Library/Homebrew/cmd/update-report.rb +++ b/Library/Homebrew/cmd/update-report.rb @@ -35,7 +35,7 @@ module Homebrew ohai "Homebrew has enabled anonymous aggregate user behaviour analytics." puts <<~EOS #{Tty.bold}Read the analytics documentation (and how to opt-out) here: - #{Formatter.url("https://docs.brew.sh/Analytics.html")}#{Tty.reset} + #{Formatter.url("https://docs.brew.sh/Analytics")}#{Tty.reset} EOS diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb index 122be2593..3963e5a7b 100644 --- a/Library/Homebrew/dev-cmd/create.rb +++ b/Library/Homebrew/dev-cmd/create.rb @@ -167,7 +167,7 @@ class FormulaCreator def template <<~EOS - # Documentation: https://docs.brew.sh/Formula-Cookbook.html + # Documentation: https://docs.brew.sh/Formula-Cookbook # http://www.rubydoc.info/github/Homebrew/brew/master/Formula # PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST! class #{Formulary.class_s(name)} < Formula diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index 1355e5945..228eb537b 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -28,7 +28,7 @@ require "language/python" # @see SharedEnvExtension # @see FileUtils # @see Pathname -# @see https://docs.brew.sh/Formula-Cookbook.html Formula Cookbook +# @see https://docs.brew.sh/Formula-Cookbook Formula Cookbook # @see https://github.com/styleguide/ruby Ruby Style Guide # # 
class Wget < Formula
@@ -2057,7 +2057,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.
-    # https://docs.brew.sh/Bottles.html
+    # https://docs.brew.sh/Bottles
     # You can ignore this block entirely if submitting to Homebrew/homebrew-core.
     # It'll be handled for you by the Brew Test Bot.
     #
diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb
index fbe6fca94..533e1d594 100644
--- a/Library/Homebrew/manpages/brew.1.md.erb
+++ b/Library/Homebrew/manpages/brew.1.md.erb
@@ -76,7 +76,7 @@ scripts that reside somewhere in the `PATH`, named `brew-` or
 to create your own commands without modifying Homebrew's internals.
 
 Instructions for creating your own commands can be found in the docs:
-
+
 
 ## SPECIFYING FORMULAE
 
@@ -193,7 +193,7 @@ can take several different forms:
     *Default:* the number of available CPU cores.
 
   * `HOMEBREW_NO_ANALYTICS`:
-    If set, Homebrew will not send analytics. See: 
+    If set, Homebrew will not send analytics. See: 
 
   * `HOMEBREW_NO_AUTO_UPDATE`:
     If set, Homebrew will not auto-update before running `brew install`,
diff --git a/Library/Homebrew/missing_formula.rb b/Library/Homebrew/missing_formula.rb
index 146c3e984..31dfa94ef 100644
--- a/Library/Homebrew/missing_formula.rb
+++ b/Library/Homebrew/missing_formula.rb
@@ -155,7 +155,7 @@ module Homebrew
               git -C "$(brew --repo #{tap})" show #{short_hash}^:#{relative_path}
 
             If you still use this formula consider creating your own tap:
-              https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap.html
+              https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap
           EOS
         end
       end
diff --git a/Library/Homebrew/os.rb b/Library/Homebrew/os.rb
index d56b03228..cc6c86537 100644
--- a/Library/Homebrew/os.rb
+++ b/Library/Homebrew/os.rb
@@ -17,7 +17,7 @@ module OS
     require "os/mac"
     # Don't tell people to report issues on unsupported versions of macOS.
     if !OS::Mac.prerelease? && !OS::Mac.outdated_release?
-      ISSUES_URL = "https://docs.brew.sh/Troubleshooting.html".freeze
+      ISSUES_URL = "https://docs.brew.sh/Troubleshooting".freeze
     end
     PATH_OPEN = "/usr/bin/open".freeze
   elsif OS.linux?
diff --git a/Library/Homebrew/utils/analytics.rb b/Library/Homebrew/utils/analytics.rb
index 9766c14db..adef3e811 100644
--- a/Library/Homebrew/utils/analytics.rb
+++ b/Library/Homebrew/utils/analytics.rb
@@ -40,7 +40,7 @@ module Utils
         end
 
         # Send analytics. Don't send or store any personally identifiable information.
-        # https://docs.brew.sh/Analytics.html
+        # https://docs.brew.sh/Analytics
         # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide
         # https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
         if ENV["HOMEBREW_ANALYTICS_DEBUG"]
-- 
cgit v1.2.3