Skip to content

Enhance documentation for textOutput and gridOutput methods #8143

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 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Enhance documentation for textOutput and gridOutput methods #8143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 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,15 @@ 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()` generates descriptions in English only. Text drawn with
* <a href="#/p5/text">text()</a> is not described. Shapes created with
* <a href="#/p5/beginShape">beginShape()</a> are not described. WEBGL mode
* and 3D shapes are not supported.
*
* Use <a href="#/p5/describe">describe()</a> and
* <a href="#/p5/describeElement">describeElement()</a> for more control
* over canvas descriptions.
*
* @method textOutput
* @param {Constant} [display] either FALLBACK or LABEL.
*
Expand Down Expand Up @@ -172,6 +181,15 @@ 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()` generates descriptions in English only. Text drawn with
* <a href="#/p5/text">text()</a> is not described. Shapes created with
* <a href="#/p5/beginShape">beginShape()</a> are not described. WEBGL mode
* and 3D shapes are not supported.
*
* Use <a href="#/p5/describe">describe()</a> and
* <a href="#/p5/describeElement">describeElement()</a> for more control
* over canvas descriptions.
*
* @method gridOutput
* @param {Constant} [display] either FALLBACK or LABEL.
*
Expand Down