Summary
mdtablefix --wrap --renumber --breaks --ellipsis --fences --in-place aggressively reflows prose to fill lines, including moving short trailing words, inline-code spans, and emphasized phrases onto preceding lines. The result is usually still valid Markdown, but it reduces readability and creates broad churn in already manually wrapped documents.
Environment
mdtablefix 0.4.0- Command run through
mdformat-all:
mdtablefix --wrap --renumber --breaks --ellipsis --fences --in-place
Reproduction
In leynos/chutoro, run:
Representative diffs:
-Profiling of the sequential FISHDBC algorithm reveals two primary performance
-bottlenecks: the creation of the HNSW graph (specifically, the `add()`
-function, which is called for every point) and the subsequent computation of
-the MST.[^8] The parallel implementation focuses on accelerating these two
-stages.
+Profiling of the sequential FISHDBC algorithm reveals two primary performance
+bottlenecks: the creation of the HNSW graph (specifically, the `add()`
+function, which is called for every point) and the subsequent computation of the
+MST.[^8] The parallel implementation focuses on accelerating these two stages.
-Distances are reported using the `strsim` crate's Levenshtein implementation,
-mirroring the DNA/protein use cases outlined in §1.3 without pulling in the
-heavier bioinformatics tooling planned for later phases. The provider
-implements `DataSource` directly so the same type can be handed to
-`Chutoro::run`, keeping the ingestion and computation pathway identical to
-numeric providers.
+Distances are reported using the `strsim` crate's Levenshtein implementation,
+mirroring the DNA/protein use cases outlined in §1.3 without pulling in the
+heavier bioinformatics tooling planned for later phases. The provider implements
+`DataSource` directly so the same type can be handed to `Chutoro::run`,
+keeping the ingestion and computation pathway identical to numeric providers.
-This ExecPlan (execution plan) is a living document. The sections
-`Constraints`, `Tolerances`, `Risks`, `Progress`, `Surprises & Discoveries`,
-`Decision Log`, and `Outcomes & Retrospective` must be kept up to date as work
-proceeds.
+This ExecPlan (execution plan) is a living document. The sections `Constraints`,
+`Tolerances`, `Risks`, `Progress`, `Surprises & Discoveries`, `Decision Log`,
+and `Outcomes & Retrospective` must be kept up to date as work proceeds.
Expected behaviour
For prose wrapping, the formatter should either preserve existing compliant wrapping by default or provide a mode that avoids reflowing already-valid paragraphs. If it does reflow, it should avoid readability regressions such as moving a single significant term or inline-code expression purely to fill the previous line.
Actual behaviour
Existing paragraphs are reflowed even when they were already within the line-length budget and intentionally wrapped for readability.
Impact
A formatting run creates large, low-signal diffs across documentation files and makes review harder without resolving all lint issues.
Summary
mdtablefix --wrap --renumber --breaks --ellipsis --fences --in-placeaggressively reflows prose to fill lines, including moving short trailing words, inline-code spans, and emphasized phrases onto preceding lines. The result is usually still valid Markdown, but it reduces readability and creates broad churn in already manually wrapped documents.Environment
mdtablefix 0.4.0mdformat-all:Reproduction
In
leynos/chutoro, run:Representative diffs:
Expected behaviour
For prose wrapping, the formatter should either preserve existing compliant wrapping by default or provide a mode that avoids reflowing already-valid paragraphs. If it does reflow, it should avoid readability regressions such as moving a single significant term or inline-code expression purely to fill the previous line.
Actual behaviour
Existing paragraphs are reflowed even when they were already within the line-length budget and intentionally wrapped for readability.
Impact
A formatting run creates large, low-signal diffs across documentation files and makes review harder without resolving all lint issues.