Fix non-deterministic tcolorbox option ordering in LaTeX output #14026
+20
−1
Conversation
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
`tColorOptions()` used `pairs()` which iterates Lua table keys in non-deterministic order, causing `.tex` output to differ between renders of the same document. Switch to `spairs()` for sorted iteration so tcolorbox options are always emitted alphabetically.
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. |
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.
When rendering the same
.qmdto PDF multiple times, the.texoutput differs between runs. The tcolorbox options in the\Shadedenvironment preamble appear in a different order each time (e.g.frame hidden, interior hidden, breakable, sharp cornersvsboxrule=0pt, sharp corners, breakable, enhanced, frame hidden, interior hidden).Root Cause
tColorOptions()insrc/resources/filters/common/latex.luauses Lua'spairs()to iterate over the options table.pairs()does not guarantee iteration order, so the emitted option string varies between runs.Fix
Replace
pairs()withspairs()(sorted pairs), which is already available globally fromsrc/resources/filters/common/table.lua. This produces alphabetically sorted options, making the output deterministic.Fixes #14017