Skip to content

Commit 0563b85

Browse files
committed
chore: make History format consistent; add test per #3537.
1 parent 0d4a91a commit 0563b85

29 files changed

Lines changed: 172 additions & 177 deletions

File tree

src/expression/parse.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,20 +82,20 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
8282
*
8383
* History:
8484
*
85-
* v0.9 Created
86-
* v0.13 Switched to one-based indices
87-
* v0.14 Added `[1,2;3,4]` notation for matrices
88-
* v0.18 Dropped the `function` keyword
89-
* v0.20 Added ternary conditional
90-
* v0.27 Allow multi-line expressions; allow functions that receive
91-
* unevaluated parameters (`rawArgs`)
85+
* v15.1 Add optional chaining operator
86+
* v14.8 Add nullish coalescing operator
87+
* v12.4 Allow trailing commas in matrices
88+
* v9.5 Support for calculations with percentages
89+
* v7.3 Supported binary, octal, and hexadecimal notation
9290
* v3 Add object notation; allow assignments internal to other
9391
* expressions
94-
* v7.3 Supported binary, octal, and hexadecimal notation
95-
* v9.5 Support for calculations with percentages
96-
* v12.4 Allow trailing commas in matrices
97-
* v14.8 Add nullish coalescing operator
98-
* v15.1 Add optional chaining operator
92+
* v0.27 Allow multi-line expressions; allow functions that receive
93+
* unevaluated parameters (`rawArgs`)
94+
* v0.20 Added ternary conditional
95+
* v0.18 Dropped the `function` keyword
96+
* v0.14 Added `[1,2;3,4]` notation for matrices
97+
* v0.13 Switched to one-based indices
98+
* v0.9 Created
9999
*
100100
* @param {string | string[] | Matrix} expr Expression to be parsed
101101
* @param {{nodes: Object<string, Node>}} [options] Available options:

src/function/arithmetic/add.js

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,9 @@ export const createAdd = /* #__PURE__ */ factory(
5353
*
5454
* History:
5555
*
56-
* v0.21.1 Fix not adding strings and matrices element wise
57-
* v3.8. Allow more than two arguments
58-
* v3.16.5 Fix passing three or more arrays or matrices.
59-
* v5.0.3 Fix matrices with a `datatype` defined
6056
* v11.6 Support matrix broadcasting
61-
* v12.4.2 Fix type definitions to allow more than two arguments
62-
* v14.5.3 Refine type definitions to not allow zero or one argument
57+
* v5.0.3 Support matrices with a `datatype` defined
58+
* v3.8 Allow more than two arguments
6359
*
6460
* @param {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} x First value to add
6561
* @param {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} y Second value to add

src/function/arithmetic/dotDivide.js

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,12 @@ export const createDotDivide = /* #__PURE__ */ factory(name, dependencies, ({ ty
4646
*
4747
* divide, multiply, dotMultiply
4848
*
49-
* History:
50-
*
51-
* v0.23 Renamed from `edivide`
52-
* v11.5.1 Improve type definitions
53-
* v11.6 Support matrix broadcasting
54-
* v14.0.0 Return a sparse matrix for sparse inputs
55-
*
49+
* History:
50+
*
51+
* v14.0.0 Return a sparse matrix for sparse inputs
52+
* v11.6 Support matrix broadcasting
53+
* v0.23 Renamed from `edivide`
54+
*
5655
* @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} x Numerator
5756
* @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} y Denominator
5857
* @return {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} Quotient, `x ./ y`

src/function/arithmetic/dotMultiply.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,11 @@ export const createDotMultiply = /* #__PURE__ */ factory(name, dependencies, ({
4040
*
4141
* multiply, divide, dotDivide
4242
*
43-
* History:
44-
*
45-
* v0.23 Renamed from `emultiply`
46-
* v11.5.1 Improve type definitions
47-
* v11.6 Support matrix broadcasting
48-
*
43+
* History:
44+
*
45+
* v11.6 Support matrix broadcasting
46+
* v0.23 Renamed from `emultiply`
47+
*
4948
* @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} x Left hand value
5049
* @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} y Right hand value
5150
* @return {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} Multiplication of `x` and `y`

src/function/arithmetic/dotPow.js

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,12 @@ export const createDotPow = /* #__PURE__ */ factory(name, dependencies, ({ typed
5151
*
5252
* pow, sqrt, multiply
5353
*
54-
* History:
55-
*
56-
* v0.23 Renamed from `epow`
57-
* v11.5.1 Improve type definitions
58-
* v11.6 Support matrix broadcasting
59-
* v14.0.0 Return a sparse matrix for sparse inputs
60-
*
54+
* History:
55+
*
56+
* v14.0.0 Return a sparse matrix for sparse inputs
57+
* v11.6 Support matrix broadcasting
58+
* v0.23 Renamed from `epow`
59+
*
6160
* @param {number | BigNumber | Complex | Unit | Array | Matrix} x The base
6261
* @param {number | BigNumber | Complex | Unit | Array | Matrix} y The exponent
6362
* @return {number | BigNumber | Complex | Unit | Array | Matrix} The value of `x` to the power `y`

src/function/arithmetic/gcd.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,13 @@ export const createGcd = /* #__PURE__ */ factory(name, dependencies, ({ typed, m
5656
*
5757
* lcm, xgcd
5858
*
59-
* History:
60-
*
61-
* v11.8 Improve type definitions
62-
* v11.7 Accept arrays as input
63-
* v11.6 Support matrix broadcasting
64-
* v0.26 Implement BigNumber support
65-
* v0.6 Created
66-
*
59+
* History:
60+
*
61+
* v11.7 Accept arrays as input
62+
* v11.6 Support matrix broadcasting
63+
* v0.26 Implement BigNumber support
64+
* v0.6 Created
65+
*
6766
* @param {... number | BigNumber | Fraction | Array | Matrix} args Two or more integer numbers
6867
* @return {number | BigNumber | Fraction | Array | Matrix} The greatest common divisor
6968
*/

src/function/arithmetic/lcm.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,13 @@ export const createLcm = /* #__PURE__ */ factory(name, dependencies, ({ typed, m
5555
*
5656
* gcd, xgcd
5757
*
58-
* History:
59-
*
60-
* v0.6 Created
61-
* v0.13 Fixed some edge cases
62-
* v0.26 Implement BigNumber support
63-
* v2.3 Support Fractions
64-
* v11.6 Support matrix broadcasting
65-
*
58+
* History:
59+
*
60+
* v11.6 Support matrix broadcasting
61+
* v2.3 Support Fractions
62+
* v0.26 Implement BigNumber support
63+
* v0.6 Created
64+
*
6665
* @param {... number | BigNumber | Array | Matrix} args Two or more integer numbers
6766
* @return {number | BigNumber | Array | Matrix} The least common multiple
6867
*/

src/function/arithmetic/mod.js

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,11 @@ export const createMod = /* #__PURE__ */ factory(name, dependencies, ({ typed, c
5959
*
6060
* History:
6161
*
62-
* v13 Handle bigints
63-
* v12.1 Support negative divisors for BigNumber and Fraction
64-
* v11.11.1 Fix round-off issues for some inputs
65-
* v11.6 Support matrix broadcasting
66-
* v7.3 Fix negative dividend for BigNumber and Fraction
67-
* v2 Handle Fractions
68-
* v0.14 Fixed non working operator
69-
* v0.2 Created
62+
* v13 Handle bigints
63+
* v12.1 Support negative divisors for BigNumber and Fraction
64+
* v11.6 Support matrix broadcasting
65+
* v2 Handle Fractions
66+
* v0.2 Created
7067
*
7168
* @param {number | BigNumber | bigint | Fraction | Array | Matrix} x Dividend
7269
* @param {number | BigNumber | bigint | Fraction | Array | Matrix} y Divisor

src/function/arithmetic/nthRoot.js

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,12 @@ export const createNthRoot = /* #__PURE__ */ factory(name, dependencies, ({ type
4747
*
4848
* History:
4949
*
50-
* v11.6 Support matrix broadcasting
51-
* v10.5.1 Improve type definitions
52-
* v5.0.0 Improve consistency with sqrt and pow
53-
* v3.1.1 Fix negative roots of zero
54-
* v2.4.1 Fix negative values like `nthRoot(-2, 3)`
55-
* v2 Handle Complex
56-
* v1.1 Created
50+
* v11.6 Support matrix broadcasting
51+
* v5.0.0 Improve consistency with sqrt and pow
52+
* v3.1.1 Support negative roots of zero
53+
* v2.4.1 Support negative values like `nthRoot(-2, 3)`
54+
* v2 Support roots of Complex
55+
* v1.1 Created
5756
*
5857
* @param {number | BigNumber | Array | Matrix | Complex} a
5958
* Value for which to calculate the nth root

src/function/arithmetic/subtract.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ export const createSubtract = /* #__PURE__ */ factory(name, dependencies, ({ typ
5151
*
5252
* add
5353
*
54-
* History:
55-
*
56-
* v11.6 Support matrix broadcasting
57-
* v5.0.3 Fix matrices with a `datatype` defined
58-
* v0.8.2 Fixed a bug when subtracting a complex number from a real number
59-
*
54+
* History:
55+
*
56+
* v11.6 Support matrix broadcasting
57+
* v5.0.3 Support matrices with a `datatype` defined
58+
* v0.8.2 Support complex - real mixed subtraction
59+
*
6060
* @param {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} x Initial value
6161
* @param {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} y Value to subtract from `x`
6262
* @return {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} Subtraction of `x` and `y`

0 commit comments

Comments
 (0)