-
-
Notifications
You must be signed in to change notification settings - Fork 10.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document desc stanza #87301
Document desc stanza #87301
Conversation
- Harmonize whitespace: blank lines before headings, trailing whitespace - Update syntax of URLs with range highlights
- Adjust whitespace / column widths to a consistent standard - Fix punctuation and capitalization of the `value` column - Harmonize formatting and phrasing of "See also" links
The CI failures (name and desc stanza out of order) will be fixed with Homebrew/brew#8265. The order was encoded incorrectly in the previous PR, Homebrew/brew#8137. Update: PR #8265 has been merged, so the tests in this one should now pass. |
ok, i've attached some descriptions. quality is very varying, i guess some are fine while would need adapting or replacement. note that we've written some of those ourselves - in this case you can consider them public domain. |
@core-code thanks a lot! I actually pinged you in this PR primarily for reference; I'd like to keep its diff relatively concise, and bulk-add descriptions in another PR. I'll take care of that separately if you don't mind. (Unless you'd like to submit them yourself — either way is fine by me!) |
sounds good, please do |
Also adjust existing documentation where appropriate, and add descriptions to two formulas as a demonstration.
Thanks, @waldyrious! |
…rates nice files Description taken from Homebrew/homebrew-cask#87301
Follow-up of Homebrew/brew#8137, which implemented #77696.
Related threads, for future reference:
Note: The desc is currently added as an optional stanza. I've added descriptions to two casks (
alfred
, which is mentioned in the documentation, andfontforge
, which was proposed as motivation in #77696). In Homebrew/brew#8137, @core-code proposed to contribute additional descs. Beyond this, I would suggest also importing/sourcing descriptions from Wikidata (example) and Repology (example).