Hi,

Breaking sentences into multiple lines can interfere with tooling, especially 
grammar checkers, and may also produce unexpected results in AI-based tools.

When a sentence is split across multiple lines, grammar checkers flag false 
errors or worse, fail to detect them entirely. This makes reviewing 
documentation more time-
consuming and increases the risk of introducing undetected mistakes. I have 
seen PRs that have introduced errors this way to our project. (Ask if you want 
examples.)

Also, given that not all of our committers are native English speakers, having 
reliable grammar checks is essential. Even as a native speaker, I make errors 
from time to time.

We've encountered this exact same issue before, and subsequent updates to our 
documentation compounded the errors. Some contributors either didn't use a 
grammar checker or mistakenly believed theirs was working when it wasn’t 
(because of the extra line breaks). As a result, errors remained in the 
documentation for an extended period, and they required significant effort 
(several days) to fix.

For these reasons, I prefer Style 2, but with line breaks only at full stops, 
explanation marks and the like. Breaking on commas gives rise to the same 
issues mentioned above.

Kind regards,
Justin

Reply via email to