slachiewicz opened a new pull request, #723:
URL: https://github.com/apache/maven-pmd-plugin/pull/723

   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 in `maven-site-plugin` use.
   
   **Verified** by rebuilding and comparing against the original FML rendering: 
the quotation marks match again, no anchor changed, and the page is otherwise 
identical.
   
   <sub>Drafted with Claude - please verify</sub>
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to