Trim verbose comments

Author: kzhou314

.github/actions/file/src/generateIssueBody.ts

@@ -40,8 +40,7 @@ ${acceptanceCriteria}
 function describeWhat(finding: Finding): string {
   const reason = `because ${finding.problemShort}. Learn more about why this was flagged by visiting ${finding.problemUrl}.`
 
-  // Axe findings carry every element that failed the rule. List them all so the
-  // issue reflects the full scope of the violation, not just one example node.
+  // Axe carries every failing element; list them all, not just the first.
   if (finding.nodes && finding.nodes.length > 0) {
     const count = finding.nodes.length
     const subject = count === 1 ? 'an element' : `${count} elements`

.github/actions/file/src/updateFilingsWithNewFindings.ts

@@ -5,10 +5,8 @@ function getFilingKey(filing: ResolvedFiling | RepeatedFiling): string {
 }
 
 function getFindingKey(finding: Finding): string {
-  // Axe reports every element failing a rule under a single rule-level finding,
-  // so the rule itself is the stable identity. Keying on one element's exact
-  // markup was fragile: any DOM shift produced a new key and re-filed an issue
-  // that was already tracked. Axe findings therefore key on the rule, not HTML.
+  // Axe groups every failing element under one rule, so key on the rule, not the
+  // element's HTML, which shifts with DOM changes and re-files tracked issues.
   if (finding.scannerType === 'axe' && finding.ruleId) {
     return `${finding.url};axe;${finding.ruleId}`
   }

.github/actions/file/tests/updateFilingsWithNewFindings.test.ts

@@ -25,9 +25,7 @@ const cachedFiling: RepeatedFiling = {
 
 describe('updateFilingsWithNewFindings', () => {
   it('re-matches an axe finding to its existing issue after the element HTML shifts', () => {
-    // The same rule fails on the same page, but a layout change altered the
-    // element's surrounding markup. The finding should still map to issue #1
-    // rather than being treated as a brand new violation.
+    // Same rule and page, but the element's markup shifted; should still map to issue #1.
     const shiftedFinding: Finding = {
       ...cachedFinding,
       html: '<span class="post-meta">old markup wrapped in a new container</span>',

.github/actions/find/src/findForUrl.ts

@@ -85,9 +85,7 @@ async function runAxeScan({
 
   if (rawFindings) {
     for (const violation of rawFindings.violations) {
-      // Axe groups every element that fails a rule into one violation. Capture
-      // all of them so a single issue can report the rule's full scope on the
-      // page, and so matching keys on the rule rather than one element's markup.
+      // Capture every failing element, not just the first, so one issue covers the rule.
       await addFinding({
         scannerType: 'axe',
         url,