Merge branch 'develop' into faster-dense-matrix-iterator

Author: josdejong

HISTORY.md

@@ -1,5 +1,11 @@
 # History
 
+# unpublished changes since 14.6.0
+
+- Fix: #3519, #3368 categories "Core functions" and "Construction functions"
+  missing from the generated function overview.
+- Fix #3517: `printTransformDependencies` not exported in the type definitions.
+
 # 2025-07-25, 14.6.0
 
 - Feat: new function `toBest(unit, unitList, offset)`, and corresponding

src/core/function/config.js

@@ -17,7 +17,6 @@ export function configFactory (config, emit) {
    *
    * Examples:
    *
-   *
    *     import { create, all } from 'mathjs'
    *
    *     // create a mathjs instance

src/expression/parse.js

@@ -66,7 +66,7 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
    *     node1.compile().evaluate() // 5
    *
    *     let scope = {a:3, b:4}
-   *     const node2 = math.parse('a * b') // 12
+   *     const node2 = math.parse('a * b')
    *     node2.evaluate(scope) // 12
    *     const code2 = node2.compile()
    *     code2.evaluate(scope) // 12

src/type/string.js

@@ -16,13 +16,13 @@ export const createString = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *
    * Examples:
    *
-   *    math.string(4.2)               // returns string '4.2'
-   *    math.string(math.complex(3, 2) // returns string '3 + 2i'
+   *    math.string(4.2)                // returns string '4.2'
+   *    math.string(math.complex(3, 2)) // returns string '3 + 2i'
    *
    *    const u = math.unit(5, 'km')
-   *    math.string(u.to('m'))         // returns string '5000 m'
+   *    math.string(u.to('m'))          // returns string '5000 m'
    *
-   *    math.string([true, false])     // returns ['true', 'false']
+   *    math.string([true, false])      // returns ['true', 'false']
    *
    * See also:
    *

test/node-tests/doc.test.js

@@ -86,6 +86,10 @@ function extractValue (spec) {
   return value
 }
 
+const ignoreFunctions = new Set([
+  'config'
+])
+
 const knownProblems = new Set([
   'setUnion', 'unequal', 'equal', 'deepEqual', 'compareNatural', 'randomInt',
   'random', 'pickRandom', 'kldivergence',
@@ -97,7 +101,10 @@ const knownProblems = new Set([
   'mod', 'floor', 'fix', 'expm1', 'exp',
   'ceil', 'cbrt', 'add', 'slu',
   'rationalize', 'qr', 'lusolve', 'lup', 'derivative',
-  'symbolicEqual', 'schur', 'sylvester', 'freqz', 'round'
+  'symbolicEqual', 'schur', 'sylvester', 'freqz', 'round',
+  'import', 'typed',
+  'unit', 'sparse', 'matrix', 'index', 'bignumber', 'fraction', 'complex',
+  'parse'
 ])
 
 let issueCount = 0
@@ -371,6 +378,10 @@ describe('Testing examples from (jsdoc) comments', function () {
   for (const category in byCategory) {
     describe('category: ' + category, function () {
       for (const doc of byCategory[category]) {
+        if (ignoreFunctions.has(doc.name)) {
+          continue
+        }
+
         it('satisfies ' + doc.name, function () {
           if (debug) {
             console.log(`      Testing ${doc.name} ...`) // can remove once no known failures; for now it clarifies "PLEASE RESOLVE"

tools/docgenerator.js

@@ -567,18 +567,18 @@ export function collectDocs (functionNames, inputPath) {
     if (!path.includes('docs') && functionIndex !== -1) {
       if (path.includes('expression')) {
         category = 'expression'
-      } else if (/\/lib\/cjs\/type\/[a-zA-Z0-9_]*\/function/.test(fullPath)) {
+      } else if (/\/src\/type\/[a-zA-Z0-9_]*\/function/.test(fullPath)) {
         // for type/bignumber/function/bignumber.js, type/fraction/function/fraction.js, etc
         category = 'construction'
-      } else if (/\/lib\/cjs\/core\/function/.test(fullPath)) {
+      } else if (/\/src\/core\/function/.test(fullPath)) {
         category = 'core'
       } else {
         category = path[functionIndex + 1]
       }
-    } else if (fullPath.endsWith('/lib/cjs/expression/parse.js')) {
+    } else if (fullPath.endsWith('/src/expression/parse.js')) {
       // TODO: this is an ugly special case
       category = 'expression'
-    } else if (path.join('/').endsWith('/lib/cjs/type')) {
+    } else if (path.join('/').endsWith('/src/type')) {
       // for boolean.js, number.js, string.js
       category = 'construction'
     }

types/index.d.ts

@@ -4079,7 +4079,8 @@ export const {
   concatTransformDependencies,
   stdTransformDependencies,
   sumTransformDependencies,
-  varianceTransformDependencies
+  varianceTransformDependencies,
+  printTransformDependencies
 }: Record<string, FactoryFunctionMap>
 
 export interface Matrix<T = MathGeneric> {