Creating a new localization rule set for vale #788
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ; Vale configuration file to test the `AdjectivesWithNouns` rule | ||
| StylesPath = ../../../styles | ||
| MinAlertLevel = warning | ||
| [*.adoc] | ||
| Localization.TermsWarnings = YES |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| the following | ||
| the previous |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| the following steps | ||
| the following functions | ||
| the following procedure | ||
| the following chapter | ||
| the following table | ||
| the following image | ||
| the following section | ||
| the previous steps | ||
| the previous functions | ||
| the previous procedure | ||
| the previous chapter | ||
| the previous table | ||
| the previous image | ||
| the previous section | ||
| this function is | ||
| those instructions are |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ; Vale configuration file to test the `CommonlyMisusedWords` rule | ||
| StylesPath = ../../../styles | ||
| MinAlertLevel = warning | ||
| [*.adoc] | ||
| Localization.TermsWarnings = YES |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| The product allows you to | ||
| This product allows you to | ||
| The product allows | ||
| This product allows | ||
| The interface allows | ||
| The UI allows | ||
| The application allows | ||
| This feature allows you to | ||
|
|
||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| might | ||
| enable | ||
| abbreviation | ||
| can | ||
| cannot | ||
| Red Hat allows you to | ||
| Red Hat allows | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ; Vale configuration file to test the `Modals` rule | ||
| StylesPath = ../../../styles | ||
| MinAlertLevel = warning | ||
| [*.adoc] | ||
| Localization.TermsWarnings = YES |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| should | ||
| could | ||
| would | ||
| will | ||
| supposed to | ||
| ought to be | ||
| may | ||
| shall |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| might | ||
| can | ||
| cannot | ||
| must | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ; Vale configuration file to test the `PhrasalVerbs` rule | ||
| StylesPath = ../../../styles | ||
| MinAlertLevel = warning | ||
| [*.adoc] | ||
| Localization.TermsWarnings = YES | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| carry out | ||
| allow for | ||
| carry on | ||
| count on | ||
| end up | ||
| get at | ||
| click on | ||
| call up | ||
| find out | ||
| print out | ||
| start up | ||
| switch on | ||
| tap on | ||
| fill in | ||
| fill out | ||
| picks up | ||
| gives up |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| do | ||
| allow | ||
| enable | ||
| continue | ||
| depend | ||
| result | ||
| imply | ||
| click |
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,5 @@ | ||||||
| ; Vale configuration file to test the `WordswithMultipleMeanings` rule | ||||||
| StylesPath = ../../../styles | ||||||
| MinAlertLevel = warning | ||||||
| [*.adoc] | ||||||
| Localization.TermsWarnings = YES | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| as | ||
| at once | ||
| once | ||
| while | ||
| since |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| after | ||
reachlekha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| one time | ||
| because | ||
| during | ||
| at the same time | ||
| as soon as | ||
| as much as | ||
| as long as | ||
|
|
||
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| extends: sequence | ||
| message: "Do not use adjectives without a noun following them. For example, use 'Complete the following steps' instead of 'Complete the following'." | ||
| link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/ | ||
| level: warning | ||
| action: | ||
| name: edit | ||
| tokens: | ||
| - the following | ||
| - the previous | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| extends: existence | ||
| ignorecase: true | ||
| level: suggestion | ||
| link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ | ||
| message: 'Only use allow if you are talking about permission. For ability, use enable.' | ||
| # source: https://github.com/redhat-documentation/vale-at-red-hat/issues/515 | ||
| tokens: | ||
| - The product allows you to | ||
| - This product allows you to | ||
| - The product allows | ||
| - This product allows | ||
| - The interface allows | ||
| - The UI allows | ||
| - The application allows | ||
| - This feature allows you to | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| extends: existence | ||
| ignorecase: true | ||
| level: warning | ||
| link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ | ||
| message: "Avoid using modals like 'should', 'may', or 'will' because they can introduce uncertainty." | ||
| # source: https://github.com/redhat-documentation/vale-at-red-hat/issues/515 | ||
| tokens: | ||
| - should | ||
| - could | ||
| - would | ||
| - will | ||
| - supposed to be | ||
| - ought to be | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
|
There was a problem hiding this comment. General comment for this rule - as it is laid out below, there will be a huge amount of false positives for this rule. Need to reduce the false positives to make this useful. |
||
| extends: substitution | ||
reachlekha marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ignorecase: true | ||
| level: warning | ||
| link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ | ||
| message: "Avoid using phrasal verbs. Consider using '%s' rather than '%s'." | ||
| scope: sentence | ||
| action: | ||
| name: replace | ||
| swap: | ||
| # Start each error message with "Do not use ..." | ||
| # Error messages must be single quoted. | ||
|
Comment on lines
+11
to
+12
There was a problem hiding this comment. I don't get this comment. It seems related to the error message,not the swap section There was a problem hiding this comment. @aireilly Could you please help clarify this rule? |
||
| carry out: do | ||
| allow for: allow|enable | ||
| carry on: continue | ||
| count on: depend | ||
| end up: result | ||
| get at: imply | ||
| click on: click | ||
| find out: find | ||
| print out: print | ||
| start up | switch on: start | ||
| tap on: tap | ||
| picks up: takes | ||
| fill in: complete | ||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| extends: existence | ||
| ignorecase: true | ||
| level: warning | ||
| link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ | ||
| message: "Avoid words that have multiple meanings. For example, instead of words like "as" or "since" which have multiple meanings, use "because"." | ||
| # source: https://github.com/redhat-documentation/vale-at-red-hat/issues/515 | ||
| tokens: | ||
| - as | ||
| - at once | ||
| - once | ||
| - while | ||
| - since | ||
|
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.