Skip to content

Commit f89a204

Browse files
committed
Document that it's in radians
1 parent 7f28dcc commit f89a204

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/type/p5.Font.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -234,15 +234,15 @@ export class Font {
234234
* path and are more precise.
235235
*
236236
* `simplifyThreshold` removes collinear points if it's set to a number other
237-
* than 0. The value represents the threshold angle to use when determining
237+
* than 0. The value represents the threshold angle in radians to use when determining
238238
* whether two edges are collinear.
239239
*
240240
* @param {String} str string of text.
241241
* @param {Number} x x-coordinate of the text.
242242
* @param {Number} y y-coordinate of the text.
243243
* @param {Object} [options] Configuration:
244244
* @param {Number} [options.sampleFactor=0.1] The ratio of the text's path length to the number of samples.
245-
* @param {Number} [options.simplifyThreshold=0] A minmum angle between two segments. Segments with a shallower angle will be merged.
245+
* @param {Number} [options.simplifyThreshold=0] A minmum angle in radian sbetween two segments. Segments with a shallower angle will be merged.
246246
* @return {Array<Object>} array of point objects, each with `x`, `y`, and `alpha` (path angle) properties.
247247
*
248248
* @example
@@ -306,15 +306,15 @@ export class Font {
306306
* path and are more precise.
307307
*
308308
* `simplifyThreshold` removes collinear points if it's set to a number other
309-
* than 0. The value represents the threshold angle to use when determining
309+
* than 0. The value represents the threshold angle in radians to use when determining
310310
* whether two edges are collinear.
311311
*
312312
* @param {String} str string of text.
313313
* @param {Number} x x-coordinate of the text.
314314
* @param {Number} y y-coordinate of the text.
315315
* @param {Object} [options] Configuration options:
316316
* @param {Number} [options.sampleFactor=0.1] The ratio of the text's path length to the number of samples.
317-
* @param {Number} [options.simplifyThreshold=0] A minmum angle between two segments. Segments with a shallower angle will be merged.
317+
* @param {Number} [options.simplifyThreshold=0] A minmum angle in radians between two segments. Segments with a shallower angle will be merged.
318318
* @return {Array<Array<Object>>} array of point objects, each with `x`, `y`, and `alpha` (path angle) properties.
319319
*
320320
* @example

0 commit comments

Comments
 (0)