search

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

Set acceptable acronyms and initialisms in headers #54

Closed iainelder closed 1 year ago

iainelder commented 1 year ago

Is there way to do this?

Some technical acryonyms and initialisms are better understood than the phrases they stand in for.

XML? JSON? SQL? Not even Microsoft spells these out. JSON is already pronounced as "jason" and SQL as "sequel".

As a workaround I can just disable this rule.

Microsoft.HeadingAcronyms = NO

With an acceptance list it could help to keep uncommon jargon out of headers.

jdkato commented 1 year ago

You can do this with a custom vocabulary.

It probably would also be useful to ignore some of the well-known ones by default.

iainelder commented 1 year ago

Thanks, @jdkato. I already use a custom vocabulary for spellchecking.

I don't see how it helps with the HeadingAcronyms rule.

Do I need to change a setting?

jdkato commented 1 year ago

If you have a term, such as "JSON," in your accept.txt it won't be reported by Microsoft.HeadingAcronyms.

iainelder commented 1 year ago

It works for me! Thanks.