josdejong/mathjs

Documentation of Unit.format() is incomplete

Open

#3440 aperta il 28 mar 2025

Vedi su GitHub
 (3 commenti) (2 reazioni) (0 assegnatari)JavaScript (1298 fork)batch import
category:unitsdocumentationgood first issue

Metriche repository

Star
 (13.832 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Describe the bug The documentation at https://mathjs.org/docs/datatypes/units.html just says "The function will determine the best fitting prefix for the unit", and the Class page at https://mathjs.org/docs/reference/classes/unit.html. One place or the other should provide detail on how the best prefix is selecting, documenting the bias toward the current unit, and the preference for a larger number of tenths over a large number of hundreds (which not everyone may agree with). The absence of such documentation leads to concerns such as #3430.

Guida contributor

Direzione di ricerca
Aggiornare la documentazione delle unità per spiegare come Unit.format() seleziona il prefisso migliore, inclusi il bias verso l'unità corrente e la preferenza per un numero maggiore di decimi rispetto ai centinaia. Aggiungere esempi e fare riferimento all'algoritmo.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
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
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90