josdejong/mathjs

No embedded docs for (some?) units

Open

#2 449 ouverte le 26 févr. 2022

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)JavaScript (1 298 forks)batch import
bugcategory:unitsdocumentationhelp wanted

Métriques du dépôt

Stars
 (13 832 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez les définitions d'unités dans le répertoire 'src/unit' pour trouver toutes les unités définies. Vérifiez chaque unité pour les chaînes de documentation intégrées. Ajoutez la documentation manquante pour des unités comme 'candela' et 'angstrom'. Ensuite, créez un test (probablement dans 'test/unit') qui itère sur toutes les unités et affirme que chacune possède une chaîne de documentation. Référez vous aux modèles de documentation existants dans la base de code.
Stack technique
javascripttypescript
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85