Skip to content

Docs describe function limits and best practice - #9114

Open
Ayush4958 wants to merge 2 commits into
processing:mainfrom
Ayush4958:docs-describe-function-limits-and-best-practice
Open

Docs describe function limits and best practice#9114
Ayush4958 wants to merge 2 commits into
processing:mainfrom
Ayush4958:docs-describe-function-limits-and-best-practice

Conversation

@Ayush4958

Copy link
Copy Markdown

Resolves #9105

Changes:

  • Added a Best Practices section for describe() & describeElement() in contributor_docs/web_accessibility.md
  • Documented TTS engine limitations regarding transliterations
  • Documented macOS VoiceOver's failure to respect the lang attribute for Latin Script langs

Screenshots of the change:
NA

PR Checklist

@Ayush4958

Copy link
Copy Markdown
Author

hi @perminder-17 ,

PR is ready for review
take time to review

thanks ....

@kvnloo

kvnloo commented Aug 31, 2026

Copy link
Copy Markdown

Thanks for landing this in contributor_docs/web_accessibility.md — that is the right file for #9105, and both requested bullets are present.

One accuracy gap vs current main (describe.js still describe(text, display) / describeElement(name, text, display); _describeHTML does not set lang):

The VoiceOver bullet talks about the HTML lang attribute as if describe() / describeElement() already emit it. They do not, until the optional lang work in #9100. #9105 is intentionally docs-ahead of that API, but the new section should say so in one clause so contributors do not think the attribute is already on the fallback/label nodes.

Suggested tightening (wording only; no API change):

No need to tick the inline-reference / unit-test boxes for this contributor-doc change, and please do not add JSDoc lang syntax until #9100 actually lands the parameter.

Branch is behind main (mergeable_state: behind); the +7-line append should rebase cleanly.

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.

Update describe function limits and best practices

2 participants