josdejong / josdejong/mathjs

Document the known undocumented functions/symbols

Open
#3,417 0 comments 0 reactions 0 assignees View on GitHub
bug documentation good first issue help wanted
Dominant language
JavaScript
Stars
15.1k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.