Skip to content

Conversation

hxrshxz
Copy link

@hxrshxz hxrshxz commented Oct 5, 2025

Resolves

Changes:

Updated JSDoc documentation for textOutput() and gridOutput() in src/accessibility/outputs.js to clearly document known limitations.

PR Checklist

…iling known limitations and alternatives for accessible canvas descriptions.
@Copilot Copilot AI review requested due to automatic review settings October 5, 2025 03:48
Copy link

welcome bot commented Oct 5, 2025

🎉 Thanks for opening this pull request! For guidance on contributing, check out our contributor guidelines and other resources for contributors!
🤔 Please ensure that your PR links to an issue, which has been approved for work by a maintainer; otherwise, there might already be someone working on it, or still ongoing discussion about implementation. You are welcome to join the discussion in an Issue if you're not sure!
🌸 Once your PR is merged, be sure to add yourself to the list of contributors on the readme page !

Thank You!

Copy link

@Copilot Copilot AI left a 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() and describeElement() 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.

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.

1 participant