Unify markdown formatting
ruestefa opened this issue · 2 comments
AFAIK there's no standard (in the blueprint) on how to format markdown files. In some files, new lines are started mid-sentence (presumably to adhere to some maximum width), while in other cases, one or more sentences are placed on separate lines. I just did a quick test (on gitlab), and all three approaches format the same, but I think it would be good to have some consistency.
(Personally, I'd favor the one-sentence-per-line approach because it makes the source files easier to navigate then multiple-sentences-per-line, while the fixed-width approach is bound to break down when sentences are edited unless it's enforced somehow.)
A quick google search revealed mdformat, which looks basically like black for markdown. I haven't tried it, but if it works well, this would take the formatting out of our hands, which (judging from experience with black) might be the best solution. I'll try it out and report here.
Thoughts?
To me this sounds as a useful addition :-)
Yes, would be great :)