Skip to content
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

Merged
merged 6 commits into from
Aug 11, 2020
Merged

Document desc stanza #87301

merged 6 commits into from
Aug 11, 2020

Conversation

waldyrious
Copy link
Contributor

@waldyrious waldyrious commented Aug 9, 2020

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, and fontforge, 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).

- 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
@waldyrious
Copy link
Contributor Author

waldyrious commented Aug 9, 2020

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.

@core-code
Copy link
Contributor

@core-code proposed to contribute additional descs.

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.
others are taken from description of the app on Mac App Store or from the description of the app from the homepage. in this case i guess they are copyrighted by the vendor. but i believe no vendor would have anything against using their description. its basically free promotion/marketing. also the copyrightability of such small text snippets could be disputed.

descriptions.txt

@waldyrious
Copy link
Contributor Author

@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!)

@core-code
Copy link
Contributor

and bulk-add descriptions in another PR. I'll take care of that separately if you don't mind.

sounds good, please do

Also adjust existing documentation where appropriate,
and add descriptions to two formulas as a demonstration.
@reitermarkus reitermarkus merged commit 469d720 into Homebrew:master Aug 11, 2020
@reitermarkus
Copy link
Member

Thanks, @waldyrious!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants