josdejong/mathjs

Make documentation clearer that the top-level elements of a 2D rectangular array are considered **rows** of matrices.

Open

#2,618 建立於 2022年7月6日

在 GitHub 查看
 (8 留言) (1 反應) (0 負責人)JavaScript (1,298 fork)batch import
documentationhelp wanted

倉庫指標

Star
 (13,832 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

I think it would be very helpful if the docs for MathJS mentioned that math.multiply on matrices was pre-multiplication, rather than post-multiplication.

Especially given that all the language at https://mathjs.org/docs/reference/functions/multiply.html strongly implies that math.multiply(a, b) is the product ab for the rest of the types. The only indication that it's pre-multiplication for matrices is somewhat buried down in the example, where it's only implicit in the dimensions of the input matrices.

Thanks! :)

貢獻者指南

研究方向
該問題要求更新 'math.multiply' 的文件，明確說明其對矩陣執行的是前乘（pre multiplication）。目前描述對其他類型暗示了後乘，這導致了混淆。為解決此問題，請查閱位於 https://mathjs.org/docs/reference/functions/multiply.html 的現有文件，並添加一個清晰的聲明：對於矩陣參數，該運算是前乘（即 'math.multiply(a, b)' 計算 ab，其中 a 被 b 左乘）。同時考慮添加一個說明：二維矩形陣列的頂層元素被視為行。無需進行程式碼變更；僅需修改文件文字。
技術棧
javascript
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85