Creating a new localization rule set for vale #788
Conversation
|
Click here to review and test in web IDE: |
|
🎊 Navigate the preview: https://redhat-documentation-vale-at-red-hat-788.surge.sh 🎊 |
|
Have you reviewed https://www.ibm.com/docs/en/ibm-style?topic=medium-global-audiences? I bet there are lots of things we could incorporate |
.vale/fixtures/Localization/WordswithMultipleMeanings/testinvalid.adoc
Outdated
Show resolved
Hide resolved
Also maybe, "picks? up," "gives? up," or "sets? up" |
| allow | enable: allow for | ||
| continue: carry on | ||
| depend: count on | ||
| result: end up |
There was a problem hiding this comment.
This will flag every instance of result in source. There will be many false positives.
| depend: count on | ||
| result: end up | ||
| imply: get at | ||
| click: click on |
There was a problem hiding this comment.
This will flag every instance of click, even if it is followed by "on".
| @@ -0,0 +1,24 @@ | |||
| --- | |||
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.
| @@ -12,3 +12,11 @@ tokens: | |||
| - this chapter | |||
| - this section | |||
| - this subsection | |||
| - The following | |||
There was a problem hiding this comment.
https://www.ibm.com/docs/en/ibm-style?topic=word-usage#following
Can we make this more useful by creating a sequence rule that returns instances of "following" where it is not in the adjectival position before a noun?
Hint:
https://github.com/aireilly/vale-at-red-hat/blob/add-pos-using-rule/.vale/styles/RedHat/Using.yml
| swap: | ||
| # Start each error message with "Do not use ..." | ||
| # Error messages must be single quoted. | ||
| do: carry out |
There was a problem hiding this comment.
I think all these rules are mixed up. They should be in the form bad: good
Chandralekha-RedHat
force-pushed
the
localization
branch
from
2fcbdcc
to
2e89ff3
Compare
| # Start each error message with "Do not use ..." | ||
| # Error messages must be single quoted. |
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?
| StylesPath = ../../../styles | ||
| MinAlertLevel = warning | ||
| [*.adoc] | ||
| Localization.TermsWarnings = YES |
There was a problem hiding this comment.
| Localization.TermsWarnings = YES | |
| Localization.PhrasalVerbs = YES |
| StylesPath = ../../../styles | ||
| MinAlertLevel = warning | ||
| [*.adoc] | ||
| Localization.TermsWarnings = YES |
There was a problem hiding this comment.
| Localization.TermsWarnings = YES | |
| Localization.WordswithMultipleMeanings = YES |
Creates a new localization rule set for highlighting common words that can cause trouble for translators.
The first cut includes the following word categories :
@chloeredhat @aireilly @rolfedh @rohennes - Please help review! Thanks!