Turn off FormulaAudit/{Desc,Homepage} for docs

- We don't need this blanket enabled, we only have a few docs where it actually matters that there's a description, it's just cruft having to invent descriptions.
This commit is contained in:
Issy Long 2024-02-02 15:37:01 +00:00 committed by GitHub
parent bcd3a78f6d
commit ca92fca770
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 15 additions and 21 deletions

View File

@ -13,6 +13,12 @@ AllCops:
FormulaAudit/Comments:
Enabled: false
# This forces us to use dummy descriptions/homepages in example formulae which we don't need to clutter the docs with.
FormulaAudit/Desc:
Enabled: false
FormulaAudit/Homepage:
Enabled: false
Layout/LineLength:
Exclude:
- Bottles.md # The bottle block line length is long in its full form.

View File

@ -122,8 +122,7 @@ Special exceptions are OpenSSL and LibreSSL. Things that use either *should* be
```ruby
class Foo < Formula
desc "Example formula"
homepage "https://example.com"
# ...
depends_on "httpd" => [:build, :test]
depends_on xcode: ["9.3", :build]
@ -266,8 +265,7 @@ If all else fails, you'll want to use [`resource`](https://rubydoc.brew.sh/Formu
```ruby
class Foo < Formula
desc "Example formula"
homepage "https://example.com"
# ...
url "https://example.com/foo-1.0.tar.gz"
resource "pycrypto" do
@ -648,9 +646,7 @@ Formulae can specify an alternate download for the upstream projects developm
```ruby
class Foo < Formula
desc "Description"
homepage "https://example.com"
# ...
head "https://github.com/some/package.git", branch: "main" # the default is "master"
end
```
@ -659,8 +655,7 @@ You can also bundle the URL and any `head`-specific dependencies and resources i
```ruby
class Foo < Formula
desc "Description"
homepage "https://example.com"
# ...
head do
url "https://svn.code.sf.net/p/project/code/trunk"
@ -677,8 +672,7 @@ When parsing a download URL, Homebrew auto-detects the resource type it points t
```ruby
class Foo < Formula
desc "Some package"
homepage "https://github.com/some/package"
# ...
url "https://github.com/some/package.git",
tag: "v1.6.2",
revision: "344cd2ee3463abab4c16ac0f9529a846314932a2"
@ -724,8 +718,6 @@ class MyDownloadStrategy < SomeHomebrewDownloadStrategy
end
class Foo < Formula
desc "Some package"
homepage "https://example.com"
url "something", using: MyDownloadStrategy
end
```
@ -887,8 +879,7 @@ If you want to add an [`option`](https://rubydoc.brew.sh/Formula#option-class_me
```ruby
class Yourformula < Formula
desc "Description"
homepage "https://example.com"
# ...
url "https://example.com/yourformula-1.0.tar.gz"
sha256 "abc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1"
# ...
@ -923,8 +914,7 @@ Any initialization steps that aren't necessarily part of the install process can
```ruby
class Foo < Formula
desc "Description"
homepage "https://example.com"
# ...
url "https://example.com/foo-1.0.tar.gz"
def post_install

View File

@ -54,8 +54,7 @@ class Foo < Formula
include Language::Python::Virtualenv
name "foo"
desc "Bar"
homepage "https://example.com"
# ...
url "..."
sha256 "abc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1"
@ -72,8 +71,7 @@ class Foo < Formula
include Language::Python::Virtualenv
name "foo"
desc "Bar"
homepage "https://example.com"
# ...
url "https://example.com/foo-1.0.tar.gz"
sha256 "abc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1"