Keep the FAQ quotation marks straight - #723
Merged
Merged
Conversation
The FML page rendered straight quotation marks, being XML. In Markdown flexmark's smart-punctuation rewrites a bare " into a typographic pair, so the converted page changed what the reader sees: "failures" -> “failures” "warnings" -> “warnings” "UnusedPrivateMethod" -> “UnusedPrivateMethod” The third is a PMD rule name that a reader may copy into a ruleset, so a curly quote there is actively unhelpful. Writing " in the source keeps them straight, which is the convention the already-converted pages in maven-site-plugin use. Verified by rebuilding the site and comparing against the FML rendering: the quotation marks match the original again, and no anchor changed. Generated-by: Claude Opus 5 (1M context)
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
1 participant
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.
Follow-up to #722, which converted this FAQ from FML to Markdown.
FML is XML, so it rendered quotation marks exactly as written. Markdown goes through flexmark, whose smart-punctuation extension rewrites a bare
"into a typographic pair - so the converted page silently changed the visible text:Three pairs:
"failures","warnings"and"UnusedPrivateMethod".The last is a PMD rule name a reader may copy into a ruleset, where a curly quote is actively unhelpful.
Writing
"in the Markdown source keeps them straight. That is the convention the already-converted pages inmaven-site-pluginuse.Verified by rebuilding and comparing against the original FML rendering: the quotation marks match again, no anchor changed, and the page is otherwise identical.
Drafted with Claude - please verify