Skip to content

Conversation

hxrshxz
Copy link
Contributor

@hxrshxz hxrshxz commented Oct 5, 2025

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

…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.

Copy link
Collaborator

@perminder-17 perminder-17 left a 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.

@hxrshxz hxrshxz requested a review from perminder-17 October 6, 2025 17:19
@hxrshxz hxrshxz changed the title Enhance documentation for textOutput() and gridOutput() methods Fix Broken examples for textOutput() and gridOutput() and Enhance documentation for textOutput() and gridOutput() methods Oct 7, 2025
@hxrshxz
Copy link
Contributor Author

hxrshxz commented Oct 13, 2025

@perminder-17 Please have a look

Copy link
Member

@ksen0 ksen0 left a 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

@hxrshxz hxrshxz changed the title Fix Broken examples for textOutput() and gridOutput() and Enhance documentation for textOutput() and gridOutput() methods Fix Broken examples for textOutput() and gridOutput() Oct 13, 2025
@hxrshxz
Copy link
Contributor Author

hxrshxz commented Oct 13, 2025

I have moved the documentation part into a separate PR #8143

@hxrshxz hxrshxz requested review from ksen0 and perminder-17 October 13, 2025 19:00
@ksen0 ksen0 merged commit 5dd7361 into processing:main Oct 13, 2025
2 checks passed
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.

3 participants