Skip to content

autoformatting markdown lines #416

@egpbos

Description

@egpbos

@bouweandela has introduced autoformatting in #406 (at least once it is merged). Of course, this triggers conversation on the style to be applied. I'm looking for some more opinions. Please keep the conversation civil 😇

The particular point we discussed was line breaks. Three options were discussed:

  1. Use a maximum line width. This increases file readability.
  2. One line == one sentence, i.e. don't line-break sentences. This increases git diff readability (no meaningless diff lines just because line breaks shifted).
  3. Hybrid: always start a sentence on a new line, but also implement a maximum line width. This at least minimizes meaningless diff lines inside multi-sentence paragraphs.

I am personally a fan of option 2, just because I hate the mental load in reviews of having to skip over meaningless diff sections. Maybe I'm being unreasonable, though, and others don't feel this as much. What do people prefer? Are there yet other options?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions