diff options
| author | Nikolaus Wittenstein | 2015-05-19 13:06:06 -0400 |
|---|---|---|
| committer | Mike McQuaid | 2015-05-25 17:23:49 +0100 |
| commit | 86365470e6a2a02c1a54f75fae818b779375b079 (patch) | |
| tree | b0b3648c79c347dd47630f555a44c8a2abfc145a | |
| parent | 60f23778533100997715e2dd52a400a50a62e8ca (diff) | |
| download | brew-86365470e6a2a02c1a54f75fae818b779375b079.tar.bz2 | |
Add a desc field to Formula
| -rw-r--r-- | Library/Homebrew/formula.rb | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index 19852beb5..285b47ff4 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -163,6 +163,12 @@ class Formula Bottle.new(self, bottle_specification) if bottled? end + # The description of the software. + # @see .desc + def desc + self.class.desc + end + # The homepage for the software. # @see .homepage def homepage @@ -685,6 +691,7 @@ class Formula def to_hash hsh = { "name" => name, + "desc" => desc, "homepage" => homepage, "versions" => { "stable" => (stable.version.to_s if stable), @@ -922,6 +929,12 @@ class Formula attr_reader :keg_only_reason # @!attribute [w] + # A one-line description of the software. Used by users to get an overview + # of the software and Homebrew maintainers. + # Shows when running `brew info`. + attr_rw :desc + + # @!attribute [w] # The homepage for the software. Used by users to get more information # about the software and Homebrew maintainers as a point of contact for # e.g. submitting patches. |
