errata-ai / Microsoft

A Vale-compatible implementation of the Microsoft Writing Style Guide.
https://github.com/errata-ai/vale
MIT License
85 stars 46 forks source link

Improve acronyms rule to match defined acronyms #44

Closed politician closed 8 months ago

politician commented 2 years ago

The Microsoft guide says that acronyms shouldn't be used unless they are spelled out. However, the current Vale rule does not allow for this.

Actual behavior:

Screenshot 2022-06-23 at 13 38 12

Expected behavior:

Because personal access token is spelled out just before the use of the acronym, it should not fail.

jdkato commented 2 years ago

The current implementation expects the definition's case to match, for example,

You must use a Personal Access Token (PAT).

would yield no alert.

politician commented 2 years ago

You are right, I had actually tried it but it didn't work because my markdown formatter put it on the next line. I guess that's too much of an edge case to bother.

Screenshot 2022-06-24 at 11 13 04

politician commented 2 years ago

I just made sure that the parser could pick it up, it does and it even recognizes my next usage of PAT. Great!

Screenshot 2022-06-24 at 11 18 29