Bad English writing

Bug report

Hi! Thanks for this awesome project. This has alleviated a lot of configuration pains. However, I have some suggestions to make:

What’s wrong

Broken English in documentation and error messages all over the place, a good example is this. What do you mean “incorrect”? It’s correct, the linter just suggests an alternative style with little examples and bad English to explain the rationale.

This does not help the user to improve their code, this just adds confusion, or worse, nudge the users to turn off everything they don’t understand.

There are also lots of spelling errors, wrong usage of tenses, redundant words etc that make reading very unpleasant.

Even the Github issue template is bad. If should be “How should it be”, not “How is that should be”.

How is that should be

Get an English speaker on the team, or write strings in German, use gettext to extract them, and throw it into a service like Lokalise or Smartling to translate into English properly.

[Dreamsorcerer]

The example given is perfectly valid English. I’m not sure why you think there is a language/grammar issue there.

It’s correct, the linter just suggests an alternative style with little examples and bad English to explain the rationale.

It’s incorrect according to the wemake rules, which should be implied by the fact you are using wemake’s opionated ruleset. I think reading the full explanation on that page is perfectly understandable for an experienced developer.

It could perhaps do with some minor improvements for less experienced developers though. For example: They may not understand some of the jargon (loop iter etc.) “…not make much sense. You can use tuples instead.” Doesn’t actually explain why. This is self-evident to an experienced developer, but newer developers might not understand why.

Overall, the level of English I’m seeing here is close to native, just some occassional small mistakes. So, I’m not really sure exactly why you think it’s a grammar/language issue, it seems to me that maybe you’re just expecting more detail? Maybe some examples of what you think it should look like would be useful?

[sobolevn]

Sure, please change any docs you feel like changing 😃 I even cannot write well in my native language 😆