Skip to content

Commit 028e25a

Browse files
kodster28daisyfaithauma
authored andcommitted
[Vale] Be more limited in check descriptions (#22163)
1 parent 42912af commit 028e25a

File tree

12 files changed

+13
-15
lines changed

12 files changed

+13
-15
lines changed

.hyperlint/automations/styles/cloudflare-automation/EOLWhitespace.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: gitlab_base.EOLWhitespace
33
description: |
44
Checks that there is no useless whitespace at the end of lines.
55
extends: existence
6-
message: "Remove whitespace characters from the end of the line."
6+
message: "Remove whitespace characters from the end of the line. Only remove the whitespace and nothing else."
77
link: https://docs.gitlab.com/development/documentation/styleguide/
88
vocab: false
99
level: warning

.hyperlint/automations/styles/cloudflare-automation/HeadingLinks.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
name: gitlab_base.HeadingLink
33
description: |
44
Do not include links in a heading.
5-
Headings already have self-referencing anchor links,
6-
and they're used for generating the table of contents.
7-
Adding a link will break the anchor linking behavior.
5+
Headings already have self-referencing anchor links.
86
extends: existence
9-
message: "Do not use links in headings."
7+
message: "Do not use links in headings. Only update the links and nothing else."
108
vocab: false
119
level: error
1210
ignorecase: true

.hyperlint/automations/styles/cloudflare-automation/HeadingPunctuation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
extends: existence
2-
message: "Don't use end punctuation in headings."
2+
message: "Don't use end punctuation in headings. Only update the punctuation and nothing else."
33
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
44
nonword: true
55
level: warning

.hyperlint/automations/styles/cloudflare-automation/NonStandardQuotes.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66
# For a list of all options, see https://vale.sh/docs/topics/styles/
77
extends: existence
8-
message: "Use standard single quotes or double quotes only. Do not use left or right quotes."
8+
message: "Use standard single quotes or double quotes only. Do not use left or right quotes. Only update the quotes and nothing else."
99
level: warning
1010
ignorecase: true
1111
link: https://developers.cloudflare.com/style-guide/grammar/punctuation-marks-and-symbols/quotation-marks/

.hyperlint/automations/styles/cloudflare-automation/UnclearAntecedent.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: gitlab_base.UnclearAntecedent
33
description: |
44
Checks for words that need a noun for clarity.
55
extends: existence
6-
message: "Instead of '%s', try starting this sentence with a specific subject and verb."
6+
message: "Instead of '%s', try starting this sentence with a specific subject and verb. Only update this part of the sentence and nothing else."
77
link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#this-these-that-those
88
vocab: false
99
level: warning

.hyperlint/automations/styles/cloudflare/Contractions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# For a list of all options, see https://vale.sh/docs/topics/styles/
77

88
extends: substitution
9-
message: "Do not use contractions. Use '%s' instead of '%s'."
9+
message: "Do not use contractions. Use '%s' instead of '%s'. Only change the contractions, nothing else."
1010
link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/contractions/
1111
level: error
1212
ignorecase: true

.hyperlint/automations/styles/cloudflare/InclusiveLanguage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# For a list of all options, see https://vale.sh/docs/topics/styles/
77

88
extends: substitution
9-
message: "**Warning**: Use inclusive language. Consider '%s' instead of '%s'."
9+
message: "**Warning**: Use inclusive language. Consider '%s' instead of '%s'. Only change the words specified, nothing else."
1010
level: warning
1111
ignorecase: true
1212
swap:

.hyperlint/automations/styles/cloudflare/LatinTerms.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# For a list of all options, see https://vale.sh/docs/topics/styles/
88

99
extends: substitution
10-
message: "Use '%s' instead of '%s', but consider rewriting the sentence."
10+
message: "Use '%s' instead of '%s'. Only change the words specified, nothing else."
1111
link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/abbreviations/#ie-vs-eg
1212
level: warning
1313
nonword: true

.hyperlint/automations/styles/cloudflare/LinkChecks.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66
# For a list of all options, see https://vale.sh/docs/topics/styles/
77
extends: existence
8-
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/`)."
8+
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."
99
level: warning
1010
ignorecase: true
1111
scope: raw

.hyperlint/automations/styles/cloudflare/MeaningfulLinkWords.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66
# For a list of all options, see https://vale.sh/docs/topics/styles/
77
extends: existence
8-
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)."
8+
message: "Rewrite the link text for `%s` to be more descriptive. Only rewrite the link text, nothing else."
99
level: warning
1010
ignorecase: true
1111
scope: raw

0 commit comments

Comments
 (0)