Skip to content

Update reflow-scan text to improve clarity and reference WCAG 2.2#231

Open
taarikashenafi wants to merge 1 commit into
mainfrom
fix/reflow-scan-text-updates
Open

Update reflow-scan text to improve clarity and reference WCAG 2.2#231
taarikashenafi wants to merge 1 commit into
mainfrom
fix/reflow-scan-text-updates

Conversation

@taarikashenafi

Copy link
Copy Markdown

Closes #230

Updates the reflow-scan plugin text to improve clarity:

  • Removes mention of 256 height from comment
  • Updates problemShort to better describe the issue
  • Updates problemUrl to reference WCAG 2.2 instead of 2.1
  • Updates solutionShort to use more descriptive guidance
  • Updates solutionLong with clearer violation explanation
  • Updates test strings to match new copy

Copilot AI review requested due to automatic review settings June 17, 2026 21:09
@taarikashenafi taarikashenafi requested a review from a team as a code owner June 17, 2026 21:09
@taarikashenafi taarikashenafi self-assigned this Jun 17, 2026
GitHub Advanced Security started work on behalf of taarikashenafi June 17, 2026 21:09 View session
@taarikashenafi taarikashenafi requested a review from JoyceZhu June 17, 2026 21:10
GitHub Advanced Security finished work on behalf of taarikashenafi June 17, 2026 21:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the reflow-scan plugin’s user-facing copy (and related test expectations) to better describe the reflow finding and to reference WCAG 2.2.

Changes:

  • Revised problemShort, solutionShort, and solutionLong text for reflow findings to be clearer and more action-oriented.
  • Updated the WCAG “Understanding Reflow” link from WCAG 2.1 to WCAG 2.2.
  • Updated test expectations to match the new strings.
Show a summary per file
File Description
.github/scanner-plugins/reflow-scan/index.ts Updates reflow-scan finding copy and WCAG reference URL.
tests/site-with-errors.test.ts Updates expected strings/titles to match the revised reflow-scan copy.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 2

Comment thread .github/scanner-plugins/reflow-scan/index.ts
problemUrl: 'https://www.w3.org/WAI/WCAG22/Understanding/reflow.html',
solutionShort:
'verify if sections of content can be viewed within the 320px wide viewport without needing to scroll in two-dimensions to read the content of an individual section',
solutionLong: `The page has a scroll width of ${scrollWidth}px but a client width of only ${clientWidth}px at a 320px wide viewport, resulting in a horizontal scrollbar. Ensure that multi-line text does not require scrolling in two-dimensions to read, as this would be a violation of the WCAG 1.4.10 Reflow Success Criterion.`,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly different suggestion than the bot:

Suggested change
solutionLong: `The page has a scroll width of ${scrollWidth}px but a client width of only ${clientWidth}px at a 320px wide viewport, resulting in a horizontal scrollbar. Ensure that multi-line text does not require scrolling in two-dimensions to read, as this would be a violation of the WCAG 1.4.10 Reflow Success Criterion.`,
solutionLong: `The page has a scroll width of ${scrollWidth}px but a client width of only ${clientWidth}px at a 320px wide viewport, resulting in a horizontal scrollbar. Ensure that multi-line text does not require scrolling in two-dimensions to read, as this would be a violation of WCAG Success Criterion 1.4.10 (Reflow).`,

@taarikashenafi taarikashenafi removed their assignment Jun 17, 2026
// Check for horizontal scrolling at 320 viewport
try {
await page.setViewportSize({ width: 320, height: 256 })
await page.setViewportSize({width: 320, height: 256})

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did Prettier automatically do this?

@JoyceZhu

Copy link
Copy Markdown
Contributor

Let's also bump the patch version up here since we've changed the plugin copy a decent amount. (Whenever we add support for marking filings as Best Practices/Needs Human Review, we can upgrade the minor version)

problemShort: 'needs review: page presents a horizontal scrollbar at a 320px wide viewport',
problemUrl: 'https://www.w3.org/WAI/WCAG22/Understanding/reflow.html',
solutionShort:
'verify if sections of content can be viewed within the 320px wide viewport without needing to scroll in two-dimensions to read the content of an individual section',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'verify if sections of content can be viewed within the 320px wide viewport without needing to scroll in two-dimensions to read the content of an individual section',
'verify if sections of content can be viewed within the 320px wide viewport without needing to scroll in two dimensions to read the content of an individual section',

@JoyceZhu

Copy link
Copy Markdown
Contributor

suggested a couple wording/typo adjustments from the original request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider the following edits for the reflow-scan

3 participants