Skip to content

Drop backslash escapes that Markdown does not need - #441

Merged
slachiewicz merged 2 commits into
masterfrom
tidy-markdown-escapes
Aug 9, 2026
Merged

Drop backslash escapes that Markdown does not need#441
slachiewicz merged 2 commits into
masterfrom
tidy-markdown-escapes

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Pages converted from APT with an older doxia-converter carry an escape in front of
punctuation that is not markup where it stands: a hyphen or underscore inside a word,
a parenthesis, a full stop after a letter. The backslash renders as nothing and only
makes the source harder to read and to edit.

Only positions where the bare character can never be markup are touched. A full stop
after a digit keeps its escape, so an ordered list marker cannot appear by accident,
and angle brackets keep theirs, since would otherwise be read as a tag.
Code spans, fenced blocks and link destinations are left alone.

Drafted with Claude — please verify

Pages converted from APT with an older doxia-converter carry an escape in front of
punctuation that is not markup where it stands: a hyphen or underscore inside a word,
a parenthesis, a full stop after a letter. The backslash renders as nothing and only
makes the source harder to read and to edit.

Only positions where the bare character can never be markup are touched. A full stop
after a digit keeps its escape, so an ordered list marker cannot appear by accident,
and angle brackets keep theirs, since <escapeString> would otherwise be read as a tag.
Code spans, fenced blocks and link destinations are left alone.
@slachiewicz slachiewicz added documentation Improvements or additions to documentation maintenance Cleanup, refactoring or other internal change labels Aug 9, 2026
@slachiewicz
slachiewicz marked this pull request as draft August 9, 2026 10:34
Removing the backslashes shortened three cells, so the column padding no
longer matched what the Spotless flexmark step produces and spotless:check
failed the build. Reflowed with spotless:apply; only padding changed.

Generated-by: Claude Opus 5 (1M context)
@slachiewicz
slachiewicz marked this pull request as ready for review August 9, 2026 10:38
@slachiewicz
slachiewicz merged commit 818de57 into master Aug 9, 2026
17 checks passed
@slachiewicz
slachiewicz deleted the tidy-markdown-escapes branch August 9, 2026 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance Cleanup, refactoring or other internal change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant