josdejong/mathjs

No embedded docs for (some?) units

Open

#2,449 opened on Feb 26, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (13,832 stars) (1,298 forks)batch import
bugcategory:unitsdocumentationhelp wanted

Description

With the restored autocomplete facility in the demo, I discovered that mathjs knows about the units 'candela' and 'angstrom'. As these seem somewhat esoteric, I tried help(candela) and help('candela') (and similarly for angstrom) in the homepage demo, and all of these calls returned Error: No documentation found on "candela".

There should be (1) a test that all appropriate symbols have embedded docs, and (2) all units should have embedded docs.

Contributor guide

Tech stack
javascript
Domain
documentationtesting
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with mathjs libraryUnderstanding of embedded documentation format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Look at the unit definitions in the 'src/unit' directory to find all defined units. Check each unit for embedded documentation strings. Add missing docs for units like 'candela' and 'angstrom'. Then create a test (likely in 'test/unit') that iterates over all units and asserts that each has a documentation string. Refer to existing documentation patterns in the codebase.