josdejong/mathjs

Documentation of Unit.format() is incomplete

Open

#3,440 建立於 2025年3月28日

在 GitHub 查看
 (3 留言) (2 反應) (0 負責人)JavaScript (13,832 star) (1,298 fork)batch import
category:unitsdocumentationgood first issue

描述

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.

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
The issue requests better documentation for the Unit.format() method. Start by examining the current documentation files at https://mathjs.org/docs/datatypes/units.html and the source code for format() in the mathjs repository to understand the algorithm for selecting the best prefix. Look at the algorithm's logic, especially the bias toward the current unit and preference for larger number of tenths. Then update the documentation to describe this behavior clearly. The existing comments in issue #3430 may provide additional insight.