-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Fix Broken examples for textOutput() and gridOutput() #8125
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
Conversation
…iling known limitations and alternatives for accessible canvas descriptions.
🎉 Thanks for opening this pull request! For guidance on contributing, check out our contributor guidelines and other resources for contributors! Thank You! |
There was a problem hiding this comment.
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 enhances the JSDoc documentation for the textOutput()
and gridOutput()
accessibility methods by adding comprehensive information about their known limitations and recommending alternative approaches.
- Added detailed documentation of limitations for both methods (English-only descriptions, WEBGL incompatibility, shape detection issues)
- Recommended
describe()
anddescribeElement()
as more accurate alternatives - Improved developer awareness of when these methods may not work as expected
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, I think the points you mentioned are technically very correct but I think it sounds little odd as compared to other reference. Please keep a neutral, helpful tone for docs.
@perminder-17 Please have a look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @hxrshxz, thanks for your work on fixing the examples! Please see the comments, and also please change the body of your issue to "addresses #issue-number" because the scope of the linked issue is larger than this PR, so it should remain open
I have moved the documentation part into a separate PR #8143 |
Addresses #6992
Changes:
Before
Screencast.from.2025-10-06.21-48-30.mp4
Screencast.from.2025-10-06.22-32-44.mp4
After
Screencast.from.2025-10-06.21-50-31.mp4
Screencast.from.2025-10-06.22-34-55.mp4
PR Checklist
npm run lint
passes