Skip to content

Lots of Markdown cleanup

Robin Vobruba requested to merge hoijui/valueflows:md_cleanup into master

This fixes mainly linter warnings, and probably the most notable change, is the splitting of long lines into many short ones. I recommend to always do that in the first place, when writing Markdown that is stored on git.

Why?

  • in Markdown, one new-line has the same meaning like a simple space or TAB, similar to HTML, so this does not change formatting
  • git-diffs are line based
    • diffs become much more easy to read for humans this way, as a change is not hidden somewhere in 400 chars, but somewhere in 80 chars, plus no scrolling is necessary.
    • one gets much less merge-conflicts, as both branches would have to modify the same (short) line to trigger one, instead of in the same paragraph (long line).

Note however, that this only works with manual wrapping, as automatic wrapping (by a fixed number of chars, e.g. 80), will cause changes in all lines of the paragraph, if a single word is added or removed in the first line. Therefore I suggest, to wrap at natural language sub-sentence borders, whenever possible.

Note 2: I understand that this is a drastic change, and maybe too .. nerdy/detail-ish. I am not angry if you choose to not go this far.

Merge request reports