chore: revert History changes

gwhitney · gwhitney · commit a0241800d647 · 2025-04-16T23:45:58.000-07:00
diff --git a/src/core/function/import.js b/src/core/function/import.js
@@ -59,12 +59,6 @@ export function importFactory (typed, load, math, importedFactories) {
    *
    *    create, all
    *
-   * History:
-   *
-   *    v0.2  Created
-   *    v0.7  Changed second parameter to an options object
-   *    v2    Dropped support for direct import of a module by name
-   *
    * @param {Object | Array} functions  Object with functions to be imported.
    * @param {Object} [options]          Import options.
    */
diff --git a/src/expression/parse.js b/src/expression/parse.js
@@ -82,19 +82,6 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
    *
    *     evaluate, compile
    *
-   * History:
-   *
-   *     v0.9   Created
-   *     v0.13  Switched to one-based indices
-   *     v0.14  Added `[1,2;3,4]` notation for matrices
-   *     v0.18  Dropped the `function` keyword
-   *     v0.20  Added ternary conditional
-   *     v0.27  Allow multi-line expressions; allow functions that receive
-   *            unevaluated parameters (`rawArgs`)
-   *     v3     Add object notation; allow assignments internal to other
-   *            expressions
-   *     v7.3   Supported binary, octal, and hexadecimal notation
-   *
    * @param {string | string[] | Matrix} expr          Expression to be parsed
    * @param {{nodes: Object<string, Node>}} [options]  Available options:
    *                                                   - `nodes` a set of custom nodes
diff --git a/src/function/algebra/polynomialRoot.js b/src/function/algebra/polynomialRoot.js
@@ -52,7 +52,6 @@ export const createPolynomialRoot = /* #__PURE__ */ factory(name, dependencies,
    *     math.polynomialRoot(-2, 0, 1)                                    // [1.4142135623730951, -1.4142135623730951]
    *     math.polynomialRoot(2, -2, 1)                                    // [1 + i, 1 - i]
    *     math.polynomialRoot(math.complex(1,3), math.complex(-3, -2), 1)  // [2 + i, 1 + i]
-   *
    *     // cubic
    *     math.polynomialRoot(-6, 11, -6, 1)                               // [1, 3, 2]
    *     math.polynomialRoot(-8, 0, 0, 1)                                 // [-1 - 1.7320508075688774i, 2, -1 + 1.7320508075688774i]
@@ -62,10 +61,6 @@ export const createPolynomialRoot = /* #__PURE__ */ factory(name, dependencies,
    * See also:
    *     cbrt, sqrt
    *
-   * History:
-   *
-   *     v11.4  Created
-   *
    * @param {... number | Complex} coeffs
    *     The coefficients of the polynomial, starting with with the constant coefficent, followed
    *     by the linear coefficient and subsequent coefficients of increasing powers.
diff --git a/src/function/arithmetic/log.js b/src/function/arithmetic/log.js
@@ -41,19 +41,6 @@ export const createLog = /* #__PURE__ */ factory(name, dependencies, ({ typed, t
    *
    *    exp, log2, log10, log1p
    *
-   * History:
-   *
-   *    v0.0.2  Created
-   *    v0.2    Add optional base argument
-   *    v0.3    Handle Array input
-   *    v0.5    Handle Matrix input
-   *    v0.16   Handle BigNumber input
-   *    v0.21   Support negative BigNumbers
-   *    v11     Drop Array/Matrix support in favor of explicit map of
-   *            the scalar log function, to avoid confusion with the log
-   *            of a matrix
-   *    v14     Allow value and base to be Fractions, when the log is rational
-   *
    * @param {number | BigNumber | Fraction | Complex} x
    *            Value for which to calculate the logarithm.
    * @param {number | BigNumber | Fraction | Complex} [base=e]
diff --git a/src/function/matrix/map.js b/src/function/matrix/map.js
@@ -45,12 +45,6 @@ export const createMap = /* #__PURE__ */ factory(name, dependencies, ({ typed })
    *
    *    filter, forEach, sort
    *
-   * History:
-   *
-   *    v0.13  Created
-   *    v1.1   Clone the indices on each callback in case callback mutates
-   *    v13.1  Support multiple inputs to the callback
-   *
    * @param {Matrix | Array} x    The input to iterate on.
    * @param {Function} callback
    *     The function to call (as described above) on each entry of the input
diff --git a/src/function/relational/compare.js b/src/function/relational/compare.js
@@ -58,11 +58,6 @@ export const createCompare = /* #__PURE__ */ factory(name, dependencies, ({ type
    *
    *    equal, unequal, smaller, smallerEq, larger, largerEq, compareNatural, compareText
    *
-   * History:
-   *
-   *    v0.19  Created
-   *    v4     Changed to compare strings by numerical value
-   *
    * @param  {number | BigNumber | bigint | Fraction | Unit | string | Array | Matrix} x First value to compare
    * @param  {number | BigNumber | bigint | Fraction | Unit | string | Array | Matrix} y Second value to compare
    * @return {number | BigNumber | bigint | Fraction | Array | Matrix} Returns the result of the comparison:
diff --git a/src/function/string/format.js b/src/function/string/format.js
@@ -118,14 +118,6 @@ export const createFormat = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *
    *    print
    *
-   * History:
-   *
-   *    v0.4   Created
-   *    v0.7   Round to a consistent number of digits (rather than decimals)
-   *    v0.15  Added multiple number notations and configurable precision
-   *    v3     Added support for JSON objects
-   *    v9     Added binary, hexadecimal, and octal notations
-   *
    * @param {*} value                               Value to be stringified
    * @param {Object | Function | number} [options]  Formatting options
    * @return {string} The formatted value
diff --git a/src/function/utils/numeric.js b/src/function/utils/numeric.js
@@ -48,12 +48,6 @@ export const createNumeric = /* #__PURE__ */ factory(name, dependencies, ({ numb
    *
    *    number, fraction, bignumber, bigint, string, format
    *
-   * History:
-   *
-   *    v6       Created
-   *    v13      Added `bigint` support
-   *    v14.2.1  Prefer mathjs `bigint()` to built-in `BigInt()`
-   *
    * @param {string | number | BigNumber | bigint | Fraction } value
    *              A numeric value or a string containing a numeric value
    * @param {string} outputType
diff --git a/src/type/bigint.js b/src/type/bigint.js
@@ -64,11 +64,6 @@ export const createBigint = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *    number, bignumber, boolean, complex, index, matrix, string, unit
    *    round, floor, ceil, fix
    *
-   * History:
-   *
-   *    v13      Created
-   *    v14.2.1  Added conversion options
-   *
    * @param {string | number | BigNumber | bigint | Fraction | boolean | Array | Matrix | null} [value]  Value to be converted
    * @param {Object} [options]  Conversion options with keys `safe` and/or `round`
    * @return {bigint | Array | Matrix} The created bigint
diff --git a/src/type/boolean.js b/src/type/boolean.js
@@ -29,12 +29,6 @@ export const createBoolean = /* #__PURE__ */ factory(name, dependencies, ({ type
    *
    *    bigint, bignumber, complex, index, matrix, string, unit
    *
-   * History:
-   *
-   *    v0.11    Created
-   *    v0.16    Added conversion from BigNumber
-   *    v14.2.1  Added conversion from bigint
-   *
    * @param {string | number | boolean | Array | Matrix | null} value  A value of any type
    * @return {boolean | Array | Matrix} The boolean value
    */
diff --git a/src/type/complex/function/complex.js b/src/type/complex/function/complex.js
@@ -42,12 +42,6 @@ export const createComplex = /* #__PURE__ */ factory(name, dependencies, ({ type
    *
    *    bigint, bignumber, boolean, index, matrix, number, string, unit
    *
-   * History:
-   *
-   *    v0.5   Created
-   *    v0.16  Added conversion from BigNumber
-   *    v6     Added conversion from Fraction
-   *
    * @param {* | Array | Matrix} [args]
    *            Arguments specifying the real and imaginary part of the complex number
    * @return {Complex | Array | Matrix} Returns a complex value
diff --git a/src/type/fraction/function/fraction.js b/src/type/fraction/function/fraction.js
@@ -37,14 +37,6 @@ export const createFraction = /* #__PURE__ */ factory(name, dependencies, ({ typ
    *
    *    bigint, bignumber, number, string, unit
    *
-   * History:
-   *
-   *    v2     Created
-   *    v3     Added conversion from BigNumber
-   *    v11.8  Added conversion from Unit
-   *    v13    Added conversion from bigint
-   *    v14    Move to bigint-based fraction.js@5; construct from two bigints
-   *
    * @param {number | string | Fraction | BigNumber | bigint | Unit | Array | Matrix} [args]
    *            Arguments specifying the value, or numerator and denominator of
    *            the fraction
diff --git a/src/type/matrix/function/index.js b/src/type/matrix/function/index.js
@@ -37,14 +37,6 @@ export const createIndex = /* #__PURE__ */ factory(name, dependencies, ({ typed,
    *
    *    bignumber, boolean, complex, matrix, number, string, unit
    *
-   * History:
-   *
-   *    v?      Created
-   *    v2      Dropped support for `[start, end, step]` arguments in favor
-   *            of lists of arbitrary values; added support for Range
-   *            objects.
-   *    v11.10  Added support for arrays of booleans as indices.
-   *
    * @param {...*} ranges   Zero or more ranges or numbers.
    * @return {Index}        Returns the created index
    */
diff --git a/src/type/matrix/function/matrix.js b/src/type/matrix/function/matrix.js
@@ -31,12 +31,6 @@ export const createMatrix = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *
    *    bigint, bignumber, boolean, complex, index, number, string, unit, sparse
    *
-   * History:
-   *
-   *    v0.5  Created
-   *    v1.5  Support dense or sparse Matrix types; allow construction
-   *          from string, Array, or another Matrix.
-   *
    * @param {Array | Matrix} [data]    A multi dimensional array
    * @param {string} [format]          The Matrix storage format, either `'dense'` or `'sparse'`
    * @param {string} [datatype]        Type of the values
diff --git a/src/type/matrix/function/sparse.js b/src/type/matrix/function/sparse.js
@@ -33,10 +33,6 @@ export const createSparse = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *
    *    bignumber, boolean, complex, index, number, string, unit, matrix
    *
-   * History:
-   *
-   *    v1.5  Created
-   *
    * @param {Array | Matrix} [data]    A two dimensional array
    *
    * @return {Matrix} The created matrix
diff --git a/src/type/string.js b/src/type/string.js
@@ -28,10 +28,6 @@ export const createString = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *
    *    bigint, bignumber, boolean, complex, index, matrix, number, unit
    *
-   * History:
-   *
-   *    v0.9  Created
-   *
    * @param {* | Array | Matrix | null} [value]  A value to convert to a string
    * @return {string | Array | Matrix} The created string
    */
diff --git a/src/type/unit/function/unit.js b/src/type/unit/function/unit.js
@@ -30,14 +30,6 @@ export const createUnitFunction = /* #__PURE__ */ factory(name, dependencies, ({
    *
    *    bigint, bignumber, boolean, complex, index, matrix, number, string, createUnit
    *
-   * History:
-   *
-   *    v0.5   Created
-   *    v0.16  Support conversion from BigNumber
-   *    v2.5   Support BigNumber and Fraction values in units
-   *    v2.6   Support Complex values in units
-   *    v11.1  Allow the type of unit to be specifed by a unit (not just string)
-   *
    * @param {* | Array | Matrix} args   A number and unit.
    * @return {Unit | Array | Matrix}    The created unit
    */
diff --git a/tools/docgenerator.js b/tools/docgenerator.js
@@ -191,29 +191,6 @@ export function generateDoc (name, code) {
     return false
   }
 
-  function parseHistory () {
-    if (/^history/i.test(line)) {
-      next()
-      skipEmptyLines()
-
-      while (exists() && !empty()) {
-        let [_all, indent, version, entry] = line.match(/^(\s*)(\S*)\s+(.*)$/)
-        const moreIndent = indent + ' '
-        next()
-        while (exists() && !empty() && line.startsWith(moreIndent)) {
-          entry += ' ' + line.trim()
-          next()
-        }
-        doc.history[version] = entry
-      }
-
-      skipEmptyLines()
-
-      return true
-    }
-    return false
-  }
-
   function parseExamples () {
     if (/^example/i.test(line)) {
       next()
@@ -361,7 +338,6 @@ export function generateDoc (name, code) {
     description: '',
     syntax: [],
     where: [],
-    history: {},
     examples: [],
     seeAlso: [],
     parameters: [],
@@ -378,7 +354,6 @@ export function generateDoc (name, code) {
 
     const handled = parseSyntax() ||
         parseWhere() ||
-        parseHistory() ||
         parseExamples() ||
         parseSeeAlso() ||
         parseParameters() ||
@@ -543,15 +518,6 @@ export function generateMarkdown (doc, functions) {
         '\n'
   }
 
-  if (Object.keys(doc.history).length > 0) {
-    text += '## History\n\n' +
-      'Version | Comment\n' +
-      '------- | -------\n'
-    for (const version in doc.history) {
-      text += `${version} | ${doc.history[version]}\n`
-    }
-  }
-
   return text
 }
 

Original file line number	Diff line number	Diff line change
`@@ -59,12 +59,6 @@ export function importFactory (typed, load, math, importedFactories) {`
`59`	`59`	`*`
`60`	`60`	`* create, all`
`61`	`61`	`*`
`62`		`- * History:`
`63`		`- *`
`64`		`- * v0.2 Created`
`65`		`- * v0.7 Changed second parameter to an options object`
`66`		`- * v2 Dropped support for direct import of a module by name`
`67`		`- *`
`68`	`62`	`* @param {Object \| Array} functions Object with functions to be imported.`
`69`	`63`	`* @param {Object} [options] Import options.`
`70`	`64`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -45,12 +45,6 @@ export const createMap = /* #__PURE__ */ factory(name, dependencies, ({ typed })`
`45`	`45`	`*`
`46`	`46`	`* filter, forEach, sort`
`47`	`47`	`*`
`48`		`- * History:`
`49`		`- *`
`50`		`- * v0.13 Created`
`51`		`- * v1.1 Clone the indices on each callback in case callback mutates`
`52`		`- * v13.1 Support multiple inputs to the callback`
`53`		`- *`
`54`	`48`	`* @param {Matrix \| Array} x The input to iterate on.`
`55`	`49`	`* @param {Function} callback`
`56`	`50`	`* The function to call (as described above) on each entry of the input`
Original file line number	Diff line number	Diff line change
`@@ -58,11 +58,6 @@ export const createCompare = /* #__PURE__ */ factory(name, dependencies, ({ type`
`58`	`58`	`*`
`59`	`59`	`* equal, unequal, smaller, smallerEq, larger, largerEq, compareNatural, compareText`
`60`	`60`	`*`
`61`		`- * History:`
`62`		`- *`
`63`		`- * v0.19 Created`
`64`		`- * v4 Changed to compare strings by numerical value`
`65`		`- *`
`66`	`61`	`* @param {number \| BigNumber \| bigint \| Fraction \| Unit \| string \| Array \| Matrix} x First value to compare`
`67`	`62`	`* @param {number \| BigNumber \| bigint \| Fraction \| Unit \| string \| Array \| Matrix} y Second value to compare`
`68`	`63`	`* @return {number \| BigNumber \| bigint \| Fraction \| Array \| Matrix} Returns the result of the comparison:`
Original file line number	Diff line number	Diff line change
`@@ -48,12 +48,6 @@ export const createNumeric = /* #__PURE__ */ factory(name, dependencies, ({ numb`
`48`	`48`	`*`
`49`	`49`	`* number, fraction, bignumber, bigint, string, format`
`50`	`50`	`*`
`51`		`- * History:`
`52`		`- *`
`53`		`- * v6 Created`
`54`		- * v13 Added `bigint` support
`55`		- * v14.2.1 Prefer mathjs `bigint()` to built-in `BigInt()`
`56`		`- *`
`57`	`51`	`* @param {string \| number \| BigNumber \| bigint \| Fraction } value`
`58`	`52`	`* A numeric value or a string containing a numeric value`
`59`	`53`	`* @param {string} outputType`
Original file line number	Diff line number	Diff line change
`@@ -29,12 +29,6 @@ export const createBoolean = /* #__PURE__ */ factory(name, dependencies, ({ type`
`29`	`29`	`*`
`30`	`30`	`* bigint, bignumber, complex, index, matrix, string, unit`
`31`	`31`	`*`
`32`		`- * History:`
`33`		`- *`
`34`		`- * v0.11 Created`
`35`		`- * v0.16 Added conversion from BigNumber`
`36`		`- * v14.2.1 Added conversion from bigint`
`37`		`- *`
`38`	`32`	`* @param {string \| number \| boolean \| Array \| Matrix \| null} value A value of any type`
`39`	`33`	`* @return {boolean \| Array \| Matrix} The boolean value`
`40`	`34`	`*/`