The word 'Machine' is incorrectly flagged in instances of Java Virtual Machine (JVM):
The suggestion is to
vale: Verify your use of 'Machine' with the word usage guidelines. (RedHat.Usage)
To Reproduce
Steps to reproduce the behavior:
Add this word or expression: Java Virtual Machine
Vale reports an illegitimate alert: error, warning, suggestion:
This word or expression triggers an illegitimate vale alert of type suggestion. 'Machine'
Expected behavior
Java Virtual Machine is a proper noun. It's an official product name. When your content includes 'Java Virtual Machine' this creates annoying suggestions, which can create unnecessary churn.
This relates to the following issue: https://github.com/redhat-documentation/vale-at-red-hat/issues/189
While issue 189 requests Red Hat product names are recognized, ideally commonly used third-party products and services should also be detected and excluded from style guidance.
aireilly
commented
2 years ago
Describe the bug
The word 'Machine' is incorrectly flagged in instances of Java Virtual Machine (JVM):
The suggestion is to
vale: Verify your use of 'Machine' with the word usage guidelines. (RedHat.Usage)To Reproduce Steps to reproduce the behavior:
Expected behavior Java Virtual Machine is a proper noun. It's an official product name. When your content includes 'Java Virtual Machine' this creates annoying suggestions, which can create unnecessary churn.
This relates to the following issue: https://github.com/redhat-documentation/vale-at-red-hat/issues/189 While issue 189 requests Red Hat product names are recognized, ideally commonly used third-party products and services should also be detected and excluded from style guidance.