testthedocs / vale-styles

Checks for Vale based on popular style guides

MIT License

45 stars 9 forks source link

Homebrew: Update Vale styles #29

Closed issyl0 closed 4 years ago

issyl0 commented 4 years ago

Firstly, thanks so much for making these Vale styles available - we just implemented Vale for Homebrew's docs. ⭐️

Description

In the process of introducing Vale for Homebrew's docs, we edited some portions of our style guide according to some less easy to fix existing documentation that made more sense with different rules:

We no longer sentence case H1 headings - only H2 and below. H1 and H2 headings are Title Cased apart from some exceptions for repo names.
The "Pull Request" => "pull request" swap is only done on paragraphs, to not conflict with the above Title Case for H1 stipulation.

Type of change

[x] New feature (non-breaking change which adds functionality)

It's just updating some styles for accuracy with our new style guide items.

How Has This Been Tested?

[x] yamllint

yamllint reports only that the docs link lines are too long, which seems fine.

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] Any dependent changes have been merged and published

This change is

svx commented 4 years ago

Thanks!

ChrisChinchilla commented 4 years ago

Thanks @issyl0 And great to know you are using Vale on Homebrew, one of my favourite tools :)