Skip to content

Commit dc38176

Browse files
committed
Update vector documentation for consistency
1 parent 7bdc6d0 commit dc38176

1 file changed

Lines changed: 16 additions & 22 deletions

File tree

src/math/p5.Vector.js

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -405,20 +405,17 @@ class Vector {
405405
}
406406
}
407407

408-
409-
410408
/**
411409
* Adds to a vector's components.
412410
*
413411
* `add()` can use separate numbers, as in `v.add(1, 2, 3)`,
414412
* another <a href="#/p5.Vector">p5.Vector</a> object, as in `v.add(v2)`, or
415413
* an array of numbers, as in `v.add([1, 2, 3])`.
416414
*
417-
* Add vectors only when they are the same size: both 2-dimensional, or
418-
* both 3-dimensional. When two vectors of different sizes are added, the
419-
* smaller dimension will be used, any additional values of the longer
420-
* vector will be ignored.
421-
* For example, adding `[1, 2, 3]` and `[4, 5]` will result in `[5, 7]`.
415+
* You should add vectors only when they are the same size. When two vectors
416+
* of different sizes are added, the smaller dimension will be used, any
417+
* additional values of the longer vector will be ignored. For example,
418+
* adding `[1, 2, 3]` and `[4, 5]` will result in `[5, 7]`.
422419
*
423420
* Calling `add()` with no arguments, as in `v.add()`, has no effect.
424421
*
@@ -546,11 +543,8 @@ class Vector {
546543
return this;
547544
}
548545

549-
550-
551546
/**
552-
* Performs modulo (remainder) division with a vector's `x`, `y`, and `z`
553-
* components.
547+
* Performs modulo (remainder) division with a vector's components.
554548
*
555549
* `rem()` can use separate numbers, as in `v.rem(1, 2, 3)`,
556550
* another <a href="#/p5.Vector">p5.Vector</a> object, as in `v.rem(v2)`, or
@@ -560,8 +554,8 @@ class Vector {
560554
* will be set to their values modulo 2. Calling `rem()` with no
561555
* arguments, as in `v.rem()`, has no effect.
562556
*
563-
* Modulo vectors only when they are the same size: both 2D, or both 3D.
564-
* When two vectors of different sizes are used, the smaller dimension will be
557+
* You should modulo vectors only when they are the same size. When two
558+
* vectors of different sizes are used, the smaller dimension will be
565559
* used, any additional values of the longer vector will be ignored.
566560
* For example, taking `[3, 6, 9]` modulo `[2, 4]` will result in `[1, 2]`.
567561
*
@@ -680,16 +674,16 @@ class Vector {
680674
}
681675

682676
/**
683-
* Subtracts from a vector's `x`, `y`, and `z` components.
677+
* Subtracts from a vector's components.
684678
*
685679
* `sub()` can use separate numbers, as in `v.sub(1, 2, 3)`, another
686680
* <a href="#/p5.Vector">p5.Vector</a> object, as in `v.sub(v2)`, or an array
687681
* of numbers, as in `v.sub([1, 2, 3])`.
688682
*
689683
* Calling `sub()` with no arguments, as in `v.sub()`, has no effect.
690684
*
691-
* Subtract vectors only when they are the same size: both 2D, or both 3D.
692-
* When two vectors of different sizes are used, the smaller dimension will be
685+
* You should subtract vectors only when they are the same size. When two
686+
* vectors of different sizes are used, the smaller dimension will be
693687
* used, any additional values of the longer vector will be ignored.
694688
* For example, subtracting `[1, 2]` from `[3, 5, 7]` will result in `[2, 3]`.
695689
*
@@ -813,7 +807,7 @@ class Vector {
813807
}
814808

815809
/**
816-
* Multiplies a vector's `x`, `y`, and `z` components.
810+
* Multiplies a vector's components.
817811
*
818812
* `mult()` can use separate numbers, as in `v.mult(1, 2, 3)`, another
819813
* <a href="#/p5.Vector">p5.Vector</a> object, as in `v.mult(v2)`, or an array
@@ -823,8 +817,8 @@ class Vector {
823817
* will be multiplied by 2. Calling `mult()` with no arguments, as in `v.mult()`, has
824818
* no effect.
825819
*
826-
* Multiply vectors only when they are the same size: both 2D, or both 3D.
827-
* When two vectors of different sizes are multiplied, the smaller dimension will be
820+
* You should multiply vectors only when they are the same size. When two
821+
* vectors of different sizes are multiplied, the smaller dimension will be
828822
* used, any additional values of the longer vector will be ignored.
829823
* For example, multiplying `[1, 2, 3]` by `[4, 5]` will result in `[4, 10]`.
830824
*
@@ -1007,7 +1001,7 @@ class Vector {
10071001
}
10081002

10091003
/**
1010-
* Divides a vector's `x`, `y`, and `z` components.
1004+
* Divides a vector's components.
10111005
*
10121006
* `div()` can use separate numbers, as in `v.div(1, 2, 3)`, another
10131007
* <a href="#/p5.Vector">p5.Vector</a> object, as in `v.div(v2)`, or an array
@@ -1017,8 +1011,8 @@ class Vector {
10171011
* will be divided by 2. Calling `div()` with no arguments, as in `v.div()`, has
10181012
* no effect.
10191013
*
1020-
* Divide vectors only when they are the same size: both 2D, or both 3D.
1021-
* When two vectors of different sizes are divided, the smaller dimension will be
1014+
* You should divide vectors only when they are the same size. When two
1015+
* vectors of different sizes are divided, the smaller dimension will be
10221016
* used, any additional values of the longer vector will be ignored.
10231017
* For example, dividing `[8, 12, 21]` by `[2, 3]` will result in `[4, 4]`.
10241018
*

0 commit comments

Comments
 (0)