Skip to content

markdownfmt makes source files unreadable #2596

@xenophonf

Description

@xenophonf

Markdown-formatted content should be readable no matter how it's presented. However, the markdownfmt CI job puts paragraphs all on one line, strips sentence-ending white space, and removes vertical whitespace, making source files difficult to navigate, read, and edit due to excessively long horizontal lines and visually indistinct sections. This also negatively impacts change reviews as edits may occur somewhere in the middle of a single line. While modern tooling like git diff --word-diff or delta can help identify mid-line edits, this isn't the default. Furthermore, those tools (and others) often rely on color-coding that's difficult to perceive for significant subsets of the population.

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