search

openSUSE / suse-doc-style-checker

Style Checker for SUSE Documentation
Other
2 stars 5 forks source link

Suggest "could" -> "may" replacements #97

Open cwickert opened 8 years ago

cwickert commented 8 years ago

Phrases such as

the following steps could vary depending on your settings

should be corrected to

steps may vary…

ghost commented 8 years ago

I think our style guide would want you to use "can" in this case, see: https://github.com/SUSE/doc-styleguide/blob/develop/xml/docu_styleguide.terminology.xml#L1934

When I started the style checker, I tried to steer clear of trying to correct can/could/may/might automatically, because it seemed hard(TM).

Of course, this is still a valid bug.