Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove must which is not normative #37653

Merged
merged 1 commit into from
Jan 15, 2025
Merged

remove must which is not normative #37653

merged 1 commit into from
Jan 15, 2025

Conversation

jnurthen
Copy link
Contributor

Musts in MDN are being misinterpreted as normative requirements. There is no MUST requirement here in the ARIA spec (it is a should) so MDN should not introduce one

Description

Change must always to should to match the ARIA spec

Motivation

Devs misinterpret MDN as normative requirements

Additional details

Related issues and pull requests

Musts in MDN are being misinterpreted as normative requirements. There is no MUST requirement here in the ARIA spec (it is a should) so MDN should not introduce one
@jnurthen jnurthen requested a review from a team as a code owner January 14, 2025 21:02
@jnurthen jnurthen requested review from scottaohara and removed request for a team January 14, 2025 21:02
@github-actions github-actions bot added Content:Accessibility Accessibility docs size/xs [PR only] 0-5 LoC changed labels Jan 14, 2025
Copy link
Contributor

Preview URLs

Flaws (8)

URL: /en-US/docs/Web/Accessibility/ARIA/Roles/alertdialog_role
Title: ARIA: alertdialog role
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Accessibility/
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Accessibility/What_is_accessibility
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Accessibility/HTML
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Accessibility/CSS_and_JavaScript
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Accessibility/WAI-ARIA_basics
    • and 3 more flaws omitted

@devongovett
Copy link

There is another "must" further down the page:

The alert dialog text must have an accessible description using aria-describedby.

Whereas this is also SHOULD in the spec:

Authors SHOULD use aria-describedby on an alertdialog to reference the alert message element in the dialog.

@jnurthen
Copy link
Contributor Author

There is another "must" further down the page:

The alert dialog text must have an accessible description using aria-describedby.

Whereas this is also SHOULD in the spec:

Authors SHOULD use aria-describedby on an alertdialog to reference the alert message element in the dialog.

There are far more than one more - probably all of them should be changed but I wanted to keep this as small as possible for now.

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Thanks! 🎉

@estelle estelle merged commit cdee0a0 into mdn:main Jan 15, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Accessibility Accessibility docs size/xs [PR only] 0-5 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants