brew

https://github.com/homebrew/brew

Ruby

🍺 The missing package manager for macOS

Formula#caveats

Tell the user about any caveats regarding this package.
<pre>def caveats
  <<-EOS.undent
    Are optional. Something the user should know?
  EOS
end</pre>

<pre>def caveats
  s = <<-EOS.undent
    Print some important notice to the user when `brew info <formula>` is
    called or when brewing a formula.
    This is optional. You can use all the vars like #{version} here.
  EOS
  s += "Some issue only on older systems" if MacOS.version < :mountain_lion
  s
end</pre>

Source | Google | Stack overflow

Edit

git clone [email protected]:homebrew/brew.git

cd brew

open Library/Homebrew/formula.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Formula-caveats-for-pr


# Commit to git

git add Library/Homebrew/formula.rbgit commit -m "better docs for Formula#caveats"


# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Formula-caveats-for-pr

hub pull-request


# Celebrate!