josdejong/mathjs

No embedded docs for (some?) units

Open

#2.449 geöffnet am 26. Feb. 2022

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (1.298 Forks)batch import
bugcategory:unitsdocumentationhelp wanted

Repository-Metriken

Stars
 (13.832 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Schauen Sie sich die Einheitendefinitionen im Verzeichnis 'src/unit' an, um alle definierten Einheiten zu finden. Überprüfen Sie jede Einheit auf eingebettete Dokumentationsstrings. Fügen Sie fehlende Dokumentation für Einheiten wie 'candela' und 'angstrom' hinzu. Erstellen Sie dann einen Test (wahrscheinlich in 'test/unit'), der über alle Einheiten iteriert und behauptet, dass jede einen Dokumentationsstring hat. Beziehen Sie sich auf vorhandene Dokumentationsmuster im Codebase.
Tech Stack
javascripttypescript
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85