josdejong/mathjs

No embedded docs for (some?) units

Aperta

#2449 aperta il 26 feb 2022

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)JavaScript (1314 fork)batch import
bugcategory:unitsdocumentationhelp wanted

Metriche repository

Star
 (15.065 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina le definizioni delle unità nella directory 'src/unit' per trovare tutte le unità definite. Controlla ogni unità per le stringhe di documentazione incorporate. Aggiungi la documentazione mancante per unità come 'candela' e 'angstrom'. Quindi crea un test (probabilmente in 'test/unit') che itera su tutte le unità e asserisce che ciascuna abbia una stringa di documentazione. Fai riferimento ai modelli di documentazione esistenti nella codebase.
Tech stack
javascripttypescript
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85