
Short Sentences Make Better Docs, and a Lint Keeps Them Short
·577 words·3 mins
Look for the longest sentence in the docs of any project that’s a few years old. It’s usually a monster: three clauses, a parenthesis, an exception tucked in at the end. Every fix added a clause instead of a sentence, because that’s the smallest diff.