- Posts: 57
- Joined: 08 Jan 2016, 01:32
psi29a wrote:Honestly, I like a good hardwrap at 80 or 120 (your choice) characters. That way when viewing in something that doesn't softwrap, the document is still readable. The good news is that ReST (as parsed by Sphinx) doesn't care about line-wraps and will parse as a paragraph. The only way to not let ReST do that is to end your sentence with two white spaces.
You guys with me on the 80/120 character thing?
I think we are on the same page here, and I only talk about prose documentation.
I mentioned it because in the guide it is mentioned otherwise https://github.com/OpenMW/openmw/blob/m ... de.txt#L28
Probably, this is a much simpler explanation of the same concept: http://asciidoctor.org/docs/asciidoc-re ... e-per-line. As long as your language of choice ignores single line-breaks, it makes wonders.
Another thing to add, is that makes very easy to comment on specific lines of a PR during review.
My opinions are my own. I am just a thankful user of OpenMW with no affiliation with the dev team.