josdejong/mathjs

Document the known undocumented functions/symbols

Open

#3417 opened on Mar 10, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (13,832 stars) (1,298 forks)batch import
bugdocumentationgood first issuehelp wanted

Description

Describe the bug The node-test doc.test.js has a list of symbols that are exported on a math instance, for which it is OK that they are not documented, because they are not intended for client use, for example. It has another, much longer, list of symbols that are exported on a math instance that really should have documentation , but don't. It uses this list to avoid the node tests always failing. But it doesn't make any fuss or warning, so there has been no impetus to complete the documentation and work toward the knownUndocumented getting down to the empty list, at which point it will become an error for there to be an undocumented exported symbol, and the knownUndocumented facility can be eliminated altogether.

This issue serves to keep track of the fact that there is missing documentation that needs to be added.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptbasic documentation writing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
First, locate the file 'node test/doc.test.js' in the repository. Look for the list of known undocumented symbols (likely an array). For each symbol in that list, find its definition in the source code and write documentation comments following the project's documentation style. After adding documentation, remove the symbol from the list. Finally, run the tests to ensure they pass.