search

redhat-documentation / vale-at-red-hat

Vale config files, styles, and docs to help individuals and teams roll out Vale
https://redhat-documentation.github.io/vale-at-red-hat/
MIT License
39 stars 59 forks source link

legitimate title case not detected leading to many warnings #204

Closed michelle-purcell closed 1 year ago

michelle-purcell commented 2 years ago

Describe the bug

vale-at-red-hat flags do not detect legitimate title case and create many false-positive info messages

Examples:

To Reproduce Steps to reproduce the behavior:

  1. Add this word or expression: == Cloud So in asciidoc, create a heading that starts with the word 'cloud' and use Uppercase C as per title case.

  2. Vale reports an illegitimate alert: error, warning, suggestion.

vale: Depending on the context, consider using 'cloud' rather than 'Cloud'. (RedHat.TermsSuggestions)

Expected behavior vale-at-red-hat should ignore case-sensitive style guidance rules when the word is preceded by == or any title header.

Additional context Most of our content is about the cloud, so most of my modules are covered in info messages relating to the cloud, creating noise that makes me want to turn off warnings, and risk missing a genuine content quality improvement.

michelle-purcell commented 1 year ago

This issue is a duplicate of #353 and no longer occurs. Fixed in PR https://github.com/redhat-documentation/vale-at-red-hat/pull/352. Closing issue.