Skip to content

docs(src/math): Use describe() instead of @alt #5596

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

Merged
merged 1 commit into from
Feb 20, 2022
Merged

docs(src/math): Use describe() instead of @alt #5596

Show file tree
Hide file tree
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
111 changes: 53 additions & 58 deletions src/math/calculation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ import p5 from '../core/main';
*
* print(x); // -3
* print(y); // 3
*
* describe(`no image displayed`);
* }
* </code></div>
*
* @alt
* no image displayed
*/
p5.prototype.abs = Math.abs;

Expand Down Expand Up @@ -61,11 +60,11 @@ p5.prototype.abs = Math.abs;
* noStroke();
* text(nfc(ax, 2), ax, ay - 5);
* text(nfc(bx, 1), bx, by - 5);
*
* describe(`2 horizontal lines & number sets. increase with
* mouse x. bottom to 2 decimals`);
* }
* </code></div>
*
* @alt
* 2 horizontal lines & number sets. increase with mouse x. bottom to 2 decimals
*/
p5.prototype.ceil = Math.ceil;

Expand Down Expand Up @@ -102,11 +101,11 @@ p5.prototype.ceil = Math.ceil;
* ellipse(xm, 33, 9, 9); // Not Constrained
* fill(0);
* ellipse(xc, 66, 9, 9); // Constrained
*
* describe(`2 vertical lines. 2 ellipses move with mouse X,
* 1 does not move past lines`);
* }
* </code></div>
*
* @alt
* 2 vertical lines. 2 ellipses move with mouse X 1 does not move passed lines
*/
p5.prototype.constrain = function(n, low, high) {
p5._validateParameters('constrain', arguments);
Expand Down Expand Up @@ -152,11 +151,11 @@ p5.prototype.constrain = function(n, low, high) {
* text(nfc(d, 1), 0, -5);
* pop();
* // Fancy!
*
* describe(`2 ellipses joined by line. 1 ellipse moves with
* mouse X&Y. Distance displayed.`);
* }
* </code></div>
*
* @alt
* 2 ellipses joined by line. 1 ellipse moves with mouse X&Y. Distance displayed.
*/
/**
* @method dist
Expand Down Expand Up @@ -220,11 +219,10 @@ p5.prototype.dist = function(...args) {
* endShape();
* line(0, 0, 0, height);
* line(0, height - 1, width, height - 1);
*
* describe(`ellipse moves along a curve with mouse x. e^n displayed.`);
* }
* </code></div>
*
* @alt
* ellipse moves along a curve with mouse x. e^n displayed.
*/
p5.prototype.exp = Math.exp;

Expand Down Expand Up @@ -258,11 +256,11 @@ p5.prototype.exp = Math.exp;
* noStroke();
* text(nfc(ax, 2), ax, ay - 5);
* text(nfc(bx, 1), bx, by - 5);
*
* describe(`2 horizontal lines & number sets.
* increase with mouse x. bottom to 2 decimals`);
* }
* </code></div>
*
* @alt
* 2 horizontal lines & number sets. increase with mouse x. bottom to 2 decimals
*/
p5.prototype.floor = Math.floor;

Expand Down Expand Up @@ -302,11 +300,11 @@ p5.prototype.floor = Math.floor;
* point(c, y);
* point(d, y);
* point(e, y);
*
* describe(`5 points horizontally staggered mid-canvas.
* mid 3 are grey, outer black`);
* }
* </code></div>
*
* @alt
* 5 points horizontally staggered mid-canvas. mid 3 are grey, outer black
*/
p5.prototype.lerp = function(start, stop, amt) {
p5._validateParameters('lerp', arguments);
Expand Down Expand Up @@ -360,11 +358,11 @@ p5.prototype.lerp = function(start, stop, amt) {
* endShape();
* line(0, 0, 0, height);
* line(0, height / 2, width, height / 2);
*
* describe(`ellipse moves along a curve with mouse x.
* natural logarithm of n displayed.`);
* }
* </code></div>
*
* @alt
* ellipse moves along a curve with mouse x. natural logarithm of n displayed.
*/
p5.prototype.log = Math.log;

Expand Down Expand Up @@ -395,11 +393,10 @@ p5.prototype.log = Math.log;
* print(mag(x1, y2)); // Prints "72.80109889280519"
* line(0, 0, x2, y2);
* print(mag(x2, y2)); // Prints "106.3014581273465"
*
* describe(`4 lines of different length radiate from top left of canvas.`);
* }
* </code></div>
*
* @alt
* 4 lines of different length radiate from top left of canvas.
*/
p5.prototype.mag = function(x, y) {
p5._validateParameters('mag', arguments);
Expand All @@ -426,6 +423,7 @@ p5.prototype.mag = function(x, y) {
* let value = 25;
* let m = map(value, 0, 100, 0, width);
* ellipse(m, 50, 10, 10);
* describe(`10×10 white ellipse with in mid left canvas`);
</code></div>
*
* <div><code>
Expand All @@ -441,12 +439,11 @@ p5.prototype.mag = function(x, y) {
* //after setting withinBounds to true
* let x2 = map(mouseX, 0, width, 0, 100, true);
* ellipse(x2, 75, 25, 25);
*
* describe(`Two 25×25 white ellipses move with mouse x.
* Bottom has more range from X`);
* }
</code></div>
*
* @alt
* 10 by 10 white ellipse with in mid left canvas
* 2 25 by 25 white ellipses move with mouse x. Bottom has more range from X
*/
p5.prototype.map = function(n, start1, stop1, start2, stop2, withinBounds) {
p5._validateParameters('map', arguments);
Expand Down Expand Up @@ -490,11 +487,11 @@ p5.prototype.map = function(n, start1, stop1, start2, stop2, withinBounds) {
* // Draw the Maximum value in the array.
* textSize(32);
* text(max(numArray), maxX, maxY);
*
* describe(`Small text at top reads: Array Elements 2 1 5 4 8 9.
* Large text at center: 9`);
* }
* </code></div>
*
* @alt
* Small text at top reads: Array Elements 2 1 5 4 8 9. Large text at center: 9
*/
/**
* @method max
Expand Down Expand Up @@ -538,11 +535,11 @@ p5.prototype.max = function(...args) {
* // Draw the Minimum value in the array.
* textSize(32);
* text(min(numArray), maxX, maxY);
*
* describe(`Small text at top reads: Array Elements 2 1 5 4 8 9.
* Large text at center: 1`);
* }
* </code></div>
*
* @alt
* Small text at top reads: Array Elements 2 1 5 4 8 9. Large text at center: 1
*/
/**
* @method min
Expand Down Expand Up @@ -598,11 +595,11 @@ p5.prototype.min = function(...args) {
* let normalY = 40;
* let normalX = 20;
* text(normalized, normalX, normalY);
*
* describe(`ellipse moves with mouse. 0 shown left, 100 right,
* and updating values center`);
* }
* </code></div>
*
* @alt
* ellipse moves with mouse. 0 shown left & 100 right and updating values center
*/
p5.prototype.norm = function(n, start, stop) {
p5._validateParameters('norm', arguments);
Expand Down Expand Up @@ -635,11 +632,10 @@ p5.prototype.norm = function(n, start, stop) {
* ellipse(eLoc * 4, eLoc * 4, pow(eSize, 3), pow(eSize, 3));
*
* ellipse(eLoc * 8, eLoc * 8, pow(eSize, 4), pow(eSize, 4));
*
* describe(`small to large ellipses radiating from top left of canvas`);
* }
* </code></div>
*
* @alt
* small to large ellipses radiating from top left of canvas
*/
p5.prototype.pow = Math.pow;

Expand All @@ -655,10 +651,12 @@ p5.prototype.pow = Math.pow;
* <div><code>
* let x = round(3.7);
* text(x, width / 2, height / 2);
* describe(`"4" written in middle of canvas`);
* </code></div>
* <div><code>
* let x = round(12.782383, 2);
* text(x, width / 2, height / 2);
* describe(`"12.78" written in middle of canvas`);
* </code></div>
* <div><code>
* function draw() {
Expand All @@ -682,13 +680,10 @@ p5.prototype.pow = Math.pow;
* noStroke();
* text(nfc(ax, 2), ax, ay - 5);
* text(nfc(bx, 1), bx, by - 5);
*
* describe(`two horizontal lines rounded values displayed on top.`);
* }
* </code></div>
*
* @alt
* "4" written in middle of canvas
* "12.78" written in middle of canvas
* two horizontal lines rounded values displayed on top.
*/
p5.prototype.round = function(n, decimals) {
if (!decimals) {
Expand Down Expand Up @@ -734,11 +729,11 @@ p5.prototype.round = function(n, decimals) {
* fill(0);
* text('x = ' + x1, 0, y1 + spacing);
* text('sq(x) = ' + x2, 0, y2 + spacing);
*
* describe(`horizontal center line squared values displayed on
* top and regular on bottom.`);
* }
* </code></div>
*
* @alt
* horizontal center line squared values displayed on top and regular on bottom.
*/
p5.prototype.sq = n => n * n;

Expand Down Expand Up @@ -779,11 +774,11 @@ p5.prototype.sq = n => n * n;
* let spacing = 15;
* text('x = ' + x1, 0, y1 + spacing);
* text('sqrt(x) = ' + x2, 0, y2 + spacing);
*
* describe(`horizontal center line squareroot values displayed on
* top and regular on bottom.`);
* }
* </code></div>
*
* @alt
* horizontal center line squareroot values displayed on top and regular on bottom.
*/
p5.prototype.sqrt = Math.sqrt;

Expand Down Expand Up @@ -839,16 +834,16 @@ function hypot(x, y, z) {
* <div><code>
* text(7345.73472742, 10, 25);
* text(fract(7345.73472742), 10, 75);
* describe(`first row having a number and the second having
* the fractional part of the number`);
* </code></div>
*
* <div><code>
* text(1.4215e-15, 10, 25);
* text(fract(1.4215e-15), 10, 75);
* describe(`first row having a number expressed in scientific
* notation and the second having the fractional part of the number`);
* </code></div>
*
* @alt
* first row having a number and the second having the fractional part of the number
* first row having a number expressed in scientific notation and the second having the fractional part of the number
*/
p5.prototype.fract = function(toConvert) {
p5._validateParameters('fract', arguments);
Expand Down
4 changes: 1 addition & 3 deletions src/math/math.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@ import p5 from '../core/main';
* function draw() {
* background(255);
* line(v1.x, v1.y, mouseX, mouseY);
* describe(`draws a line from center of canvas to mouse pointer position.`);
* }
* </code></div>
*
* @alt
* draws a line from center of canvas to mouse pointer position.
*/
p5.prototype.createVector = function(x, y, z) {
if (this instanceof p5) {
Expand Down
17 changes: 7 additions & 10 deletions src/math/noise.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ let perlin; // will be initialized lazily by noise() or noiseSeed()
* xoff = xoff + 0.01;
* let n = noise(xoff) * width;
* line(n, 0, n, height);
* describe(`vertical line moves left to right with updating
* noise values.`);
* }
* </code>
* </div>
Expand All @@ -89,13 +91,11 @@ let perlin; // will be initialized lazily by noise() or noiseSeed()
* stroke(noiseVal*255);
* line(x, mouseY+noiseVal*80, x, height);
* }
* describe(`horizontal wave pattern effected by mouse x-position
* & updating noise values.`);
* }
* </code>
* </div>
*
* @alt
* vertical line moves left to right with updating noise values.
* horizontal wave pattern effected by mouse x-position & updating noise values.
*/

p5.prototype.noise = function(x, y = 0, z = 0) {
Expand Down Expand Up @@ -224,12 +224,11 @@ p5.prototype.noise = function(x, y = 0, z = 0) {
* point(x + width / 2, y);
* }
* }
* describe(`2 vertical grey smokey patterns affected by
* mouse x-position and noise.`);
* }
* </code>
* </div>
*
* @alt
* 2 vertical grey smokey patterns affected my mouse x-position and noise.
*/
p5.prototype.noiseDetail = function(lod, falloff) {
if (lod > 0) {
Expand Down Expand Up @@ -261,12 +260,10 @@ p5.prototype.noiseDetail = function(lod, falloff) {
* xoff = xoff + .01;
* let n = noise(xoff) * width;
* line(n, 0, n, height);
* describe(`vertical grey lines drawing in pattern affected by noise.`);
* }
* </code>
* </div>
*
* @alt
* vertical grey lines drawing in pattern affected by noise.
*/
p5.prototype.noiseSeed = function(seed) {
// Linear Congruential Generator
Expand Down
6 changes: 3 additions & 3 deletions src/math/p5.Vector.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ import * as constants from '../core/constants';
* ellipse(v2.x, v2.y, 50, 50);
* v1.add(v2);
* ellipse(v1.x, v1.y, 50, 50);
*
* describe(`2 white ellipses. One center-left the other
* bottom right and off canvas`);
* </code>
* </div>
*
* @alt
* 2 white ellipses. One center-left the other bottom right and off canvas
*/
p5.Vector = function Vector() {
let x, y, z;
Expand Down
Loading