dev-docs: on Pandoc update, verify quarto-dev/quarto roundtrip snapshots#14726
Merged
cderv merged 1 commit intoJul 24, 2026
Merged
Conversation
Pandoc Markdown-writer changes (e.g. display-math newline handling, list/definition-list indentation) alter the visual-editor roundtrip output in quarto-dev/quarto and can break its snapshot tests on the next prerelease. Add a checklist item to update-pandoc-checklist.md pointing to that verification, and cross-link it from cross-project-dependencies.md.
Collaborator
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documentation-only change to
dev-docs/.When Quarto bumps its bundled Pandoc, Pandoc Markdown-writer changes can alter the
visual-editor roundtrip output in the
quarto-dev/quartotooling repo and break itssnapshot tests — but nothing in our Pandoc-update process points that out, so it's only
discovered when the next prerelease turns those tests red.
This happened with the 3.8.3 → 3.10 bump: display math went back to multi-line
(reverting jgm/pandoc#11384) and definition-list indentation changed, breaking the
roundtripped-*.qmdsnapshots. See the companion fix inquarto-dev/quarto.This PR adds a step so future updates catch it up front:
dev-docs/update-pandoc-checklist.md— new item under Manual steps (the checklistthe
quarto-bld update-pandoctool tells you to complete): verifyquarto-dev/quartoroundtrip snapshot tests on the next prerelease, and open a companion PR to regenerate
affected snapshots — after confirming each change is intended Pandoc behavior and not a
transient regression (a bad snapshot can freeze a bug — see Fix failing tests after Quarto 1.9 release quarto#944).
dev-docs/cross-project-dependencies.md— note that bumping Pandoc counts as"touching a shared surface," cross-linked to the checklist.
No code or user-facing behavior changes.
Checklist
I have (if applicable):
AI-assisted PR
quarto-cliandquarto-dev/quarto; verification against real Pandoc 3.6–3.10 binaries; DeepWiki MCP for pointers