brew/Library/Homebrew/cmd/help.rb

# typed: strict
# frozen_string_literal: true

require "help"

module Homebrew
  sig { returns(T.noreturn) }
  def help
    Help.help
  end
end
Turn up the types 2023-08-08 13:54:59 -07:00			`# typed: strict`
Add frozen_string_literal to all files. 2019-04-19 15:38:03 +09:00			`# frozen_string_literal: true`

Refactor commands to remove "require cmd/help" 2018-06-05 23:19:18 -04:00			`require "help"`
help: use Commands module. 2016-09-07 20:09:29 +01:00
Only "extend self" once on the Homebrew module 2014-06-18 22:41:47 -05:00			`module Homebrew`
Turn up the types 2023-08-08 13:54:59 -07:00			`sig { returns(T.noreturn) }`
Pass remaining args to `Help`. 2020-08-02 15:36:05 +02:00			`def help`
			`Help.help`
Implement the `brew help` command This is also used by `brew <cmd> --help`. The basic idea is to have the documentation as a top level comment in each command file. To find these comments, they have to be like this `#:`. This is also used by the `brew man` command to keep the documentation DRY, and for that there are now a header and footer for the man page. 2016-04-03 20:17:01 +02:00			`end`
Optimise/simplify `brew help` Be more useful by being more concise. I referenced dozens of other mature commands’ usage to figure out what to do here. Also separated out the help into its own command for consistency. 2011-03-13 12:54:30 +00:00			`end`