Skip to content

[Vale] Be more limited in check descriptions #22163

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

Merged
merged 1 commit into from
May 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: gitlab_base.EOLWhitespace
description: |
Checks that there is no useless whitespace at the end of lines.
extends: existence
message: "Remove whitespace characters from the end of the line."
message: "Remove whitespace characters from the end of the line. Only remove the whitespace and nothing else."
link: https://docs.gitlab.com/development/documentation/styleguide/
vocab: false
level: warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
name: gitlab_base.HeadingLink
description: |
Do not include links in a heading.
Headings already have self-referencing anchor links,
and they're used for generating the table of contents.
Adding a link will break the anchor linking behavior.
Headings already have self-referencing anchor links.
extends: existence
message: "Do not use links in headings."
message: "Do not use links in headings. Only update the links and nothing else."
vocab: false
level: error
ignorecase: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
extends: existence
message: "Don't use end punctuation in headings."
message: "Don't use end punctuation in headings. Only update the punctuation and nothing else."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
nonword: true
level: warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "Use standard single quotes or double quotes only. Do not use left or right quotes."
message: "Use standard single quotes or double quotes only. Do not use left or right quotes. Only update the quotes and nothing else."
level: warning
ignorecase: true
link: https://developers.cloudflare.com/style-guide/grammar/punctuation-marks-and-symbols/quotation-marks/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: gitlab_base.UnclearAntecedent
description: |
Checks for words that need a noun for clarity.
extends: existence
message: "Instead of '%s', try starting this sentence with a specific subject and verb."
message: "Instead of '%s', try starting this sentence with a specific subject and verb. Only update this part of the sentence and nothing else."
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#this-these-that-those
vocab: false
level: warning
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# For a list of all options, see https://vale.sh/docs/topics/styles/

extends: substitution
message: "Do not use contractions. Use '%s' instead of '%s'."
message: "Do not use contractions. Use '%s' instead of '%s'. Only change the contractions, nothing else."
link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/contractions/
level: error
ignorecase: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# For a list of all options, see https://vale.sh/docs/topics/styles/

extends: substitution
message: "**Warning**: Use inclusive language. Consider '%s' instead of '%s'."
message: "**Warning**: Use inclusive language. Consider '%s' instead of '%s'. Only change the words specified, nothing else."
level: warning
ignorecase: true
swap:
Expand Down
2 changes: 1 addition & 1 deletion .hyperlint/automations/styles/cloudflare/LatinTerms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# For a list of all options, see https://vale.sh/docs/topics/styles/

extends: substitution
message: "Use '%s' instead of '%s', but consider rewriting the sentence."
message: "Use '%s' instead of '%s'. Only change the words specified, nothing else."
link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/abbreviations/#ie-vs-eg
level: warning
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion .hyperlint/automations/styles/cloudflare/LinkChecks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "**Warning**: When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`) or a local development link (`http://localhost:1111/1.1.1.1/check/`)."
message: "When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`) or a local development link (`http://localhost:1111/1.1.1.1/check/`). Only change the link, nothing else."
level: warning
ignorecase: true
scope: raw
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "**Warning**: Rewrite the link text for `%s` to be more descriptive. For more information, refer to [Descriptive link text](https://developers.cloudflare.com/style-guide/formatting/structure/links/#descriptive-link-text)."
message: "Rewrite the link text for `%s` to be more descriptive. Only rewrite the link text, nothing else."
level: warning
ignorecase: true
scope: raw
Expand Down
2 changes: 1 addition & 1 deletion .hyperlint/automations/styles/cloudflare/Repetition.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: repetition
message: "**Warning**: Remove this duplicate word: '%s'."
message: "**Warning**: Remove this duplicate word: '%s'. Only remove this duplicate word and nothing else."
level: warning
alpha: true
tokens:
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Fix spelling errors.
Fix spelling errors in the text. Only fix these spelling errors and nothing else.