fix(format): Insert paragraph-break separators between changelog blocks #89 #90

Merged
imAsparky merged 4 commits from issue-89 into main 2026-04-25 11:50:01 +00:00
Owner

closes #89

closes #89
closes #89
fix(format): Insert paragraph-break separators between changelog blocks #89
All checks were successful
Test Python 3.10 Tests passed on Python 3.10
CI / Test Python 3.10 (pull_request) Successful in 1m7s
Test Python 3.11 Tests passed on Python 3.11
CI / Test Python 3.11 (pull_request) Successful in 1m5s
Test Python 3.12 Tests passed on Python 3.12
CI / Test Python 3.12 (pull_request) Successful in 1m3s
Test Python 3.13 Tests passed on Python 3.13
CI / Test Python 3.13 (pull_request) Successful in 1m7s
Test Python 3.14 Tests passed on Python 3.14
CI / Test Python 3.14 (pull_request) Successful in 1m8s
CI / Lint and Type Check (pull_request) Successful in 52s
CI / Update Changelog (pull_request) Successful in 11s
d7e75d8a57
Distinct blockquote blocks within a changelog entry (breaking-change
description, dev notes, doc notes, Closes line, Refs line) were
emitted as consecutive `  > ...` lines. Per CommonMark, consecutive
blockquote lines collapse into a single wrapped paragraph in the
rendered HTML -- which is what every spec-compliant renderer
(Forgejo, GitHub, GitLab, Codeberg) does. The result was a wall of
running text where distinct sections were meant to be visually
separate.

Inserts a blank `  >` line between each emitted block, which produces
a paragraph break inside the same blockquote. Renderers now display
each block as its own visual paragraph.

Fixed in format() rather than per-renderer because the underlying
behaviour is part of CommonMark, not a renderer quirk; matching the
spec produces correct output everywhere.

[dev-notes]:
"""
This is the visible-output companion to the multi-line content fix
(#82). That fix made the source markdown correct; this fix makes the
rendered output look correct too. The format() method now joins
blockquote blocks with a paragraph-break separator, mirroring the
blank-line convention that already worked for multi-paragraph
content within a single block.
"""

[doc-notes]:
"""
Changelog entries with multiple blockquote sections (dev notes, doc
notes, Closes, Refs) now display as distinct paragraphs in the
rendered changelog rather than a wrapped wall of text. No action
needed; existing entries will look right on the next release.
"""

Closes #89
Refs #82, #86
imAsparky deleted branch issue-89 2026-04-25 11:50:02 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
dunwright/git-herald!90
No description provided.