docs: Max chars per line enforcement #1625

New issue

Open

opened 2026-04-08 08:31:05 +00:00 by stratself · 4 comments

stratself commented

2026-04-08 08:31:05 +00:00

Contributor

There should be consensus on max chars per line in docs which is then somehow enforceable (i.e. by prek?). I've been writing single-lined Markdowns but this doesn't render well in raw, and can complicate docs reviews.

Ghost commented

2026-04-08 08:32:13 +00:00

80 char per line

s1lv3r commented

2026-04-08 11:43:12 +00:00

Contributor

80 is madness, we're not reading on CRTs anymore.

I suggest following the rust style guide, which says "The maximum width for a line is 100 characters." (this is technically for code, but I suggest following it for docs as well)

80 is madness, we're not reading on CRTs anymore. I suggest following the [rust style guide](https://doc.rust-lang.org/beta/style-guide/index.html), which says "[The maximum width for a line is 100 characters.](https://doc.rust-lang.org/beta/style-guide/index.html#indentation-and-line-width)" (this is technically for code, but I suggest following it for docs as well)

Jade commented

2026-04-08 11:48:56 +00:00

Owner

The style guide that I would prefer (and have used when writing docs) has lines at a max of 100 chars, but when forced to wrap, wrapping at 80 chars. This is because re-wrapping creates line noise in a git diff, which I would prefer to avoid.

I'm not sure if there is tooling which correctly enforces this. Suggestions welcome.

s1lv3r commented

2026-04-08 11:51:04 +00:00

Contributor

I agree with the 100/80 enforcement, I believe something like markdownlint could work? It has configurable line lengths

I agree with the 100/80 enforcement, I believe something like [markdownlint](https://github.com/DavidAnson/markdownlint) could work? It has configurable line lengths

Jade added the

Documentation

Rows
Columns