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.

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.

Sadly there isn't much we can do, if breathe/doxygen/etc are not loaded, then the linked documents (rst files) are using sphinx directives that don't exist and will warn you about them. The good news is that once the initial build is done, any subsequent builds only looks at changed documents so you'll no longer get the warnings.

If you would like to write a sentence and then hardwrap to a new line for the next sentence (in a paragraph), be my guest! That makes it easier to read too. Some sentences can drag on though and should be avoided or broken up otherwise if need be hardwrapped on a comma or semi-colon.

Thankfully we have a lovely review process on github that allows people to comment, spot-fact-check and other wise be grammar-nazies.

Do we want to cover all our 'apps'? Do we also want source documentation for components?

For those curious about source documentation, it reads in from header (hpp) files. So if you are going to document anything, please put your documentation there.

Documentation in the cpp files is specific to the implementation of a function or object but not exposed to other modules. If it needs to be used/exposed outside the cpp file, then it should go in the header (hpp) file.

If everyone else feels very strongly that we should use the semantic linefeeds then I think I can get behind it. I would prefer that to a simple character limitation and to a sentence only linebreak. We should always strive for clarity regardless.

psi29a wrote: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.