(maven-pmd-plugin) 01/01: Keep the FAQ quotation marks straight

[sl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a commit to branch faq-keep-straight-quotes
in repository https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git

commit 24de034af026573d012ff5bab4e899e01a198f59
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Mon Aug 10 02:44:20 2026 +0200

    Keep the FAQ quotation marks straight
    
    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 &quot; 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)
---
 src/site/markdown/faq.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/site/markdown/faq.md b/src/site/markdown/faq.md
index 5c46d45..fa60836 100644
--- a/src/site/markdown/faq.md
+++ b/src/site/markdown/faq.md
@@ -68,10 +68,10 @@ ruleset (see property [rulesets](pmd-mojo.html#rulesets)). Each rule has a assig
 2 - medium-high, 3 - medium, 4 - medium-low, 5 - low). This priority is also used for the violation.
 
 Violations with a high enough priority can fail the build when using the [check](check-mojo.html) goal. These
-violations are called "failures". The exact priority, when to fail the build, is configured via the property
+violations are called &quot;failures&quot;. The exact priority, when to fail the build, is configured via the property
 [failurePriority](check-mojo.html#failurePriority).
 
-Violations, that have a priority too low to fail the build, are called "warnings". These warnings appear in
+Violations, that have a priority too low to fail the build, are called &quot;warnings&quot;. These warnings appear in
 the report and are displayed in the build output, if the property [verbose](check-mojo.html#verbose) is
 enabled.
 
@@ -95,7 +95,7 @@ for type resolution, but also the project's classes as well.
 When using the property [aggregate](pmd-mojo.html#aggregate), this is problematic: With aggregate=true, PMD is
 executed at the root of a multi-module project *before the individual modules are built*. Then the types of
 the individual projects are not available, which might lead to false positive findings e.g. for the rule
-"UnusedPrivateMethod". That's why this property has been deprecated.
+&quot;UnusedPrivateMethod&quot;. That's why this property has been deprecated.
 
 In order to use type resolution and aggregate together, maven needs to be execute in two passes: First pass
 will compile the projects (e.g. `mvn clean package`) and the second pass will execute PMD without clean via