archive-gh-me/mathjs
1
0
Fork 0
mirror of https://github.com/josdejong/mathjs.git synced 2026-02-01 16:07:46 +00:00
Code Issues Projects Releases Wiki Activity

Hotfix: missing functions in docs (#2556)

Browse Source 
* Fix core and construction functions missing in docs

* Cleanup unused import

* Fix function `parse` missing in docs

* Add a TODO, remove unused `relativePath`
This commit is contained in:
Jos de Jong 2022-05-11 09:57:36 +02:00 committed by GitHub
parent cce2919e3b
commit ef0c62551b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
tools/docgenerator.js
View File

@ -540,7 +540,7 @@ function cleanup (outputPath, outputRoot) {
* @param {String} inputPath Path to location of source files
* @returns {object} docinfo
* Object whose keys are function names, and whose values are objects with
* keys name, category, fullpath, relativepath, doc, and issues
* keys name, category, fullPath, doc, and issues
* giving the relevant information
*/
function collectDocs (functionNames, inputPath) {
@ -560,17 +560,18 @@ function collectDocs (functionNames, inputPath) {
if (path.indexOf('docs') === -1 && functionIndex !== -1) {
if (path.indexOf('expression') !== -1) {
category = 'expression'
} else if (/^.\/lib\/type\/[a-zA-Z0-9_]*\/function/.test(fullPath)) {
} else if (/\/lib\/cjs\/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\/core\/function/.test(fullPath)) {
} else if (/\/lib\/cjs\/core\/function/.test(fullPath)) {
category = 'core'
} else {
category = path[functionIndex + 1]
}
} else if (fullPath === './lib/cjs/expression/parse.js') {
} else if (fullPath.endsWith('/lib/cjs/expression/parse.js')) {
// TODO: this is an ugly special case
category = 'expression'
} else if (path.join('/') === './lib/cjs/type') {
} else if (path.join('/').endsWith('/lib/cjs/type')) {
// for boolean.js, number.js, string.js
category = 'construction'
}
@ -581,11 +582,14 @@ function collectDocs (functionNames, inputPath) {
if (category) {
functions[name] = {
name: name,
category: category,
fullPath: fullPath,
relativePath: fullPath.substring(inputPath.length)
name,
category,
fullPath
}
} else {
// TODO: throw a warning that no category could be found (instead of silently ignoring it).
// Right now, this matches too many functions, so to do that, we first must make the glob matching relevant
// files more specific, and we need to extend the list with functions we want to ignore.
}
})