docs/vale-styles: Bump all style violations to "error" level so they fail CI#8940
Merged
issyl0 merged 3 commits intoHomebrew:masterfrom Oct 21, 2020
Merged
docs/vale-styles: Bump all style violations to "error" level so they fail CI#8940issyl0 merged 3 commits intoHomebrew:masterfrom
issyl0 merged 3 commits intoHomebrew:masterfrom
Conversation
Member
Author
|
I've attempted an upstream PR to fix (hopefully) the errors we're seeing with not being able to use On the upside, at least these "style failures" fail the CI build now! |
Member
|
Good catch! Should the rules for oxford commas and pronouns be upgraded to errors as well? |
MikeMcQuaid
approved these changes
Oct 19, 2020
Member
|
Thanks @issyl0!
Agreed. I don't personally see the point in any non-error rules as they will be ignored and the warnings be confusing when an actual error occurs. |
Member
Author
Good catch, that was an oversight rather than a deliberate choice. Done now, everything is at "error" level. |
Rylan12
approved these changes
Oct 19, 2020
- Otherwise this surfaces an error and suggests a fix that doesn't match Apple's branding.
- I added these all the way back in December 2019 in #6826, but only today realised that things have been failing unnoticeably because "warning" level exits with status code 0, so doesn't fail CI. - Upgrading to "error" level will enable us to see the style errors in our docs and fix them faster. - My editor also auto-formatted the YAML to have double quotes instead of single.
- I don't necessarily agree with this, but it's AP style that words with four or more letters should start with a capital when in titles.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
brew stylewith your changes locally?brew testswith your changes locally?brew manlocally and committed any changes?