Standardize Ocaml comment/doc line length
Summary
The current Ocaml format rules force 80 character limit per line, c.f. the .ocamlformat
.
However there is currently no such limitation enforced for comments / documentation, though there seems to be a de-facto consensus that it should also be 80 chars.
I am opening this issue as a discussion (and maybe the issue used to fix depending on the discussion conclusion):
What's the status on this?
I see two possibilities, though there may be more:
- no restriction on line length
- in that case I propose we add
wrap-comments=false
in all.ocamlformat
files to make this freedom explicit
- in that case I propose we add
- restriction on line length
- in that case I propose we add
wrap-comments=true
in all.ocamlformat
files to make this restriction explicit and make developers' and reviewers' life easier (one less thing to care about)
- in that case I propose we add
Note: some other files would likely need to be adapted too, e.g. src/tooling/lint.sh
High-tech voting system:
-
🆓 for no restriction -
🚧 for restriction
You can also vote both if both are fine by you
Edited by Julien Debon