Skip to content

Enhance documentation for textOutput() and gridOutput() methods #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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+38 −4
Open

Enhance documentation for textOutput() and gridOutput() methods #8125

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c6f5b5
Enhance documentation for textOutput() and gridOutput() methods, deta…
hxrshxz Oct 5, 2025
f55350b
improve documentation for textOutput() and gridOutput()
hxrshxz Oct 6, 2025
5f220bc
fix examples that were not working
hxrshxz Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/accessibility/outputs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ import p5 from '../core/main';
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
* to learn more about making sketches accessible.
*
* `textOutput()` has several known limitations. Descriptions are only
* generated in English. Text drawn with <a href="#/p5/text">text()</a> is
* not described. `textOutput()` does not work with WEBGL mode or 3D shapes.
* 2D primitives rendered in WEBGL may be described incorrectly because the
* camera's perspective is not accounted for. Shapes with similar features may
* be combined in descriptions, resulting in inaccurate counts. Shapes
* positioned outside the canvas boundaries are described as though they're
* visible. Custom 2D shapes created with
* <a href="#/p5/beginShape">beginShape()</a> are not described.
*
* <a href="#/p5/describe">describe()</a> and
* <a href="#/p5/describeElement">describeElement()</a> provide more accurate
* and flexible alternatives for writing canvas descriptions.
*
Copy link
Collaborator

@perminder-17 perminder-17 Oct 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Avoid absolute or negative phrasing like “does not work” and “inaccurate counts.” Prefer “not supported” and “may be imprecise.” Also, Keep a neutral, helpful tone. Also, the sketches in textOutputif you see 3rd and 4th are not working. https://p5js.org/reference/p5/textOutput/ Can this be fixed in your PR as well?

Copy link
Author

Choose a reason for hiding this comment

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

Sure , On it !

* @method textOutput
* @param {Constant} [display] either FALLBACK or LABEL.
*
Expand Down Expand Up @@ -172,6 +186,20 @@ p5.prototype.textOutput = function(display) {
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
* to learn more about making sketches accessible.
*
* `gridOutput()` has several known limitations. Descriptions are only
* generated in English. Text drawn with <a href="#/p5/text">text()</a> is
* not described. `gridOutput()` does not work with WEBGL mode or 3D shapes.
* 2D primitives rendered in WEBGL may be described incorrectly because the
* camera's perspective is not accounted for. Shapes with similar features may
* be combined in descriptions, resulting in inaccurate counts. Shapes
* positioned outside the canvas boundaries are described as though they're
* visible. Custom 2D shapes created with
* <a href="#/p5/beginShape">beginShape()</a> are not described.
*
* <a href="#/p5/describe">describe()</a> and
* <a href="#/p5/describeElement">describeElement()</a> provide more accurate
* and flexible alternatives for writing canvas descriptions.
*
* @method gridOutput
* @param {Constant} [display] either FALLBACK or LABEL.
*
Expand Down