vale-at-red-hat icon indicating copy to clipboard operation
vale-at-red-hat copied to clipboard

"By using" at the beginning of a sentence incorrectly flagged

Open emteelb opened this issue 2 years ago • 3 comments

A sentence that begins with "By using" incorrectly trips this TermsSuggestions.yml rule:

"(?<!by) using": by using|that uses

This would fix it:

"(?<![Bb]y) using": by using|that uses

I don't think I noticed mention of this in #208 but if work is being done there, perhaps this fix could be added to that work?

Otherwise, happy to submit something separately.

emteelb avatar Apr 19 '23 16:04 emteelb

Thank you @emteelb. This is a good catch and is not really related to #208.

Please feel free to open a PR to fix this issue. Or somebody in our community can pick it up.

I have verified your approach here. I think you don't need to add "By using" to the test fixture (.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc ) for this rule because the bug found in #208 might cause an issue there. So just a change the style (.vale/styles/RedHat/TermsSuggestions.yml) as outlined above is enough in this case.

FYI - We are participating in Hacktoberfest, so it would be good to open the PR after Oct 1st and we will try to get it closed before Oct 31st to ensure it's a qualifying PR for the event. :smiley_cat:

rohennes avatar Sep 21 '23 11:09 rohennes

@rohennes Happy to make a PR and open after 1 Oct. I was not aware of studio.vale.sh. This will be a big improvement to my Vale style rule writing workflow over regex101. Appreciate the mention and thanks for your guidance.

emteelb avatar Sep 21 '23 12:09 emteelb

Great, thanks so much!!

rohennes avatar Sep 21 '23 13:09 rohennes