Skip to content

Commit 5d945d4

Browse files
authored
Merge pull request #8143 from hxrshxz/docs-improvements
Enhance documentation for textOutput and gridOutput methods
2 parents 5dd7361 + e1f502d commit 5d945d4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/accessibility/outputs.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ import p5 from '../core/main';
3737
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
3838
* to learn more about making sketches accessible.
3939
*
40+
* `textOutput()` generates descriptions in English only. Text drawn with
41+
* <a href="#/p5/text">text()</a> is not described. Shapes created with
42+
* <a href="#/p5/beginShape">beginShape()</a> are not described. WEBGL mode
43+
* and 3D shapes are not supported.
44+
*
45+
* Use <a href="#/p5/describe">describe()</a> and
46+
* <a href="#/p5/describeElement">describeElement()</a> for more control
47+
* over canvas descriptions.
48+
*
4049
* @method textOutput
4150
* @param {Constant} [display] either FALLBACK or LABEL.
4251
*
@@ -180,6 +189,15 @@ p5.prototype.textOutput = function(display) {
180189
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
181190
* to learn more about making sketches accessible.
182191
*
192+
* `gridOutput()` generates descriptions in English only. Text drawn with
193+
* <a href="#/p5/text">text()</a> is not described. Shapes created with
194+
* <a href="#/p5/beginShape">beginShape()</a> are not described. WEBGL mode
195+
* and 3D shapes are not supported.
196+
*
197+
* Use <a href="#/p5/describe">describe()</a> and
198+
* <a href="#/p5/describeElement">describeElement()</a> for more control
199+
* over canvas descriptions.
200+
*
183201
* @method gridOutput
184202
* @param {Constant} [display] either FALLBACK or LABEL.
185203
*

0 commit comments

Comments
 (0)