diff --git a/doc/cask_language_reference/all_stanzas.md b/doc/cask_language_reference/all_stanzas.md index 89fd1990a0d2..90ed6f8e721f 100644 --- a/doc/cask_language_reference/all_stanzas.md +++ b/doc/cask_language_reference/all_stanzas.md @@ -10,7 +10,7 @@ Each of the following stanzas is required for every Cask. | `sha256` | no | SHA-256 checksum of the file downloaded from `url`, calculated by the command `shasum -a 256 `. Can be suppressed by using the special value `:no_check`.
See [Checksum Stanza Details](stanzas/sha256.md) for more information. | `url` | no | URL to the `.dmg`/`.zip`/`.tgz`/`.tbz2` file that contains the application.
A [comment](stanzas/url.md#when-url-and-homepage-hostnames-differ-add-a-comment) should be added if the hostnames in the `url` and `homepage` stanzas differ. Block syntax should be used for URLs that change on every visit.
See [URL Stanza Details](stanzas/url.md) for more information. | `name` | yes | String providing the full and proper name defined by the vendor.
See [Name Stanza Details](stanzas/name.md) for more information. -| `desc` | no | One-line description of the Cask. Shows when running `brew info`.
See [Desc Stanza Details](stanzas/desc.md) for more information. +| `desc` | no | One-line description of the Cask. Shows when running `brew cask info`.
See [Desc Stanza Details](stanzas/desc.md) for more information. | `homepage` | no | Application homepage; used for the `brew cask home` command. ## At Least One Artifact Stanza Is Also Required diff --git a/doc/cask_language_reference/stanzas/name.md b/doc/cask_language_reference/stanzas/name.md index 2fd86473ad1f..c4d2cc54ece8 100644 --- a/doc/cask_language_reference/stanzas/name.md +++ b/doc/cask_language_reference/stanzas/name.md @@ -2,7 +2,7 @@ `name` accepts a UTF-8 string defining the name of the software, including capitalization and punctuation. It is used to help with searchability and disambiguation. -Unlike the [token](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md), which is simplified and reduced to a limited set of characters, the `name` stanza can include the proper capitalization, spacing and punctuation to match the official name of the software. For disambiguation purposes, it is recommended to spell out the name of the application, and including the vendor name if necessary. A good example is [`pycharm-ce`](https://github.com/Homebrew/homebrew-cask/blob/fc05c0353aebb28e40db72faba04b82ca832d11a/Casks/pycharm-ce.rb#L6-L7), whose name is spelled out as `Jetbrains PyCharm Community Edition` makes sense even though it is likely never referenced as such anywhere. +Unlike the [token](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md), which is simplified and reduced to a limited set of characters, the `name` stanza can include the proper capitalization, spacing and punctuation to match the official name of the software. For disambiguation purposes, it is recommended to spell out the name of the application, and including the vendor name if necessary. A good example is [`pycharm-ce`](https://github.com/Homebrew/homebrew-cask/blob/fc05c0353aebb28e40db72faba04b82ca832d11a/Casks/pycharm-ce.rb#L6-L7), whose name is spelled out as `Jetbrains PyCharm Community Edition`, even though it is likely never referenced as such anywhere. Additional details about the software can be provided in the [desc](desc.md) stanza.