What do folks think about introducing a limit for line length in docs?
First off, here are my thoughts against the limit:
  * We should be careful about introducing more hurdles, especially for
docs. We want people, also contributors outside the community, to improve
documentation; hence we should make the process easier, or at least not
more complicated.
  * People usually render docs locally in a markdown application, that's
why line length is not that crucial like comments length.

However, I often find myself reading and updating docs from the same editor
I read and write code. In this case, 700+ lines become annoying, see e.g.
[1].

My proposal is:
  * have an agreement among committers, i.e. put it into "committing.md",
that lines in docs are generally limited to 80 chars;
  * refrain from putting this limit in both "markdown-style-guide.md" and
"c++-style-guide.md";
  * sweep-update all existing docs so contributors can follow the pattern.

[1]
https://github.com/apache/mesos/blob/a138e2246a30c4b5c9bc3f7069ad12204dcaffbc/docs/architecture.md

Reply via email to