Style: Use semantic linefeeds in markdown files #426
Description
Is your feature request related to a problem?
The docs directory contains some markdown files that will be used to generate the documentation.
The formatting of these is not ideal as they sometimes use very long lines that are cumbersome to read (and especially edit).
Also, long lines lead to larger diffs reported by git if we just change a small part of the line.
Desired solution
Markdown generally does not care about (single) line breaks. It parses 2 consecutive line breaks as a "new paragraph", and 2 trailing spaces at the end of a line as "insert linbreak".
This means we are free to insert single line breaks wherever we want, without affecting the look of the resulting HTML page.
A recommended style for markdown is thus to use "semantic linefeeds", i.e. place (unparsed) single line breaks after each sentence and between different logical parts / "chunks" within a sentence.
My suggestion is to add this to our style guide and update existing bad-formatted markdown code accordingly.
Possible alternatives
An alternative solution would be to decide that we do not want to adopt this idea.