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

bug: vale rule overrides basic grammar rule (uppercase for sentence starts) #47

Closed davidsneighbour closed 9 months ago

davidsneighbour commented 1 year ago

While I am using the VSCode plugin and the error is based on a configuration package (The Microsoft Vale package), I think that this might be a critical bug in how Vale applies the rules. Please close and let me know if I should add this issue to a different repo.

Writing verbs and phrases defined in one of the packages leads to vale complaining about them. See this sample:

20230331-18:24:56-Selection-001

The definition for this error does not allow an uppercase version. It would be an error in the middle of a sentence.

I think Vale should be able to understand that it is in (1) English and at (2) a sentence start, and the rule for an English sentence start is an uppercase character independent of any manual rules.

jdkato commented 1 year ago

I think Vale should be able to understand that it is in (1) English and at (2) a sentence start, and the rule for an English sentence start is an uppercase character independent of any manual rules.

I don't think this is true, particularly when it comes to terminology-based rules. It's better, imo, to do exactly what the rule says.

For example, something like

eBay Inc. is an American multinational e-commerce company.

should not be changed.

In this particular case:

  1. We could change the rule to explicitly allow a capitalized version when it starts a sentence; or

  2. change the message to more clearly indicate the nuance here (it's already only a warning).