Skip to content

Commit f55350b

Browse files
committed
improve documentation for textOutput() and gridOutput()
1 parent 5c6f5b5 commit f55350b

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

src/accessibility/outputs.js

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,18 @@ 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()` has several known limitations. Descriptions are only
41-
* generated in English. Text drawn with <a href="#/p5/text">text()</a> is
42-
* not described. `textOutput()` does not work with WEBGL mode or 3D shapes.
43-
* 2D primitives rendered in WEBGL may be described incorrectly because the
44-
* camera's perspective is not accounted for. Shapes with similar features may
45-
* be combined in descriptions, resulting in inaccurate counts. Shapes
46-
* positioned outside the canvas boundaries are described as though they're
47-
* visible. Custom 2D shapes created with
48-
* <a href="#/p5/beginShape">beginShape()</a> are not described.
49-
*
40+
*`textOutput()` currently generates descriptions in English only.
41+
* Text drawn with <a href="#/p5/text">text()</a> is not included in
42+
* descriptions. WEBGL mode and 3D shapes are not supported. When rendering
43+
* 2D primitives in WEBGL, descriptions may be imprecise as the camera's
44+
* perspective is not accounted for. Shapes with similar features may be
45+
* combined, which can affect shape counts. Shapes positioned outside the
46+
* canvas boundaries may still be included in descriptions. Custom 2D shapes
47+
* created with <a href="#/p5/beginShape">beginShape()</a> are not supported.
48+
*
49+
* For more precise control over canvas descriptions, consider using
5050
* <a href="#/p5/describe">describe()</a> and
51-
* <a href="#/p5/describeElement">describeElement()</a> provide more accurate
52-
* and flexible alternatives for writing canvas descriptions.
51+
* <a href="#/p5/describeElement">describeElement()</a>.
5352
*
5453
* @method textOutput
5554
* @param {Constant} [display] either FALLBACK or LABEL.
@@ -186,19 +185,18 @@ p5.prototype.textOutput = function(display) {
186185
* <a href="https://p5js.org/tutorials/writing-accessible-canvas-descriptions/">Writing accessible canvas descriptions</a>
187186
* to learn more about making sketches accessible.
188187
*
189-
* `gridOutput()` has several known limitations. Descriptions are only
190-
* generated in English. Text drawn with <a href="#/p5/text">text()</a> is
191-
* not described. `gridOutput()` does not work with WEBGL mode or 3D shapes.
192-
* 2D primitives rendered in WEBGL may be described incorrectly because the
193-
* camera's perspective is not accounted for. Shapes with similar features may
194-
* be combined in descriptions, resulting in inaccurate counts. Shapes
195-
* positioned outside the canvas boundaries are described as though they're
196-
* visible. Custom 2D shapes created with
197-
* <a href="#/p5/beginShape">beginShape()</a> are not described.
188+
*`gridOutput()` currently generates descriptions in English only.
189+
* Text drawn with <a href="#/p5/text">text()</a> is not included in
190+
* descriptions. WEBGL mode and 3D shapes are not supported. When rendering
191+
* 2D primitives in WEBGL, descriptions may be imprecise as the camera's
192+
* perspective is not accounted for. Shapes with similar features may be
193+
* combined, which can affect shape counts. Shapes positioned outside the
194+
* canvas boundaries may still be included in descriptions. Custom 2D shapes
195+
* created with <a href="#/p5/beginShape">beginShape()</a> are not supported.
198196
*
197+
* For more precise control over canvas descriptions, consider using
199198
* <a href="#/p5/describe">describe()</a> and
200-
* <a href="#/p5/describeElement">describeElement()</a> provide more accurate
201-
* and flexible alternatives for writing canvas descriptions.
199+
* <a href="#/p5/describeElement">describeElement()</a>.
202200
*
203201
* @method gridOutput
204202
* @param {Constant} [display] either FALLBACK or LABEL.

0 commit comments

Comments
 (0)