josdejong/mathjs

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

オープン

#2,618 opened on 2022/07/06

GitHub で見るコントリビューターガイド
 (8 件のコメント) (1 件のリアクション) (0 人の担当者)JavaScript (1,314 件のフォーク)batch import
documentationhelp wanted

Repository metrics

Stars
 (15,065 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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)' は a が b によって左から乗算される ab を計算する）であることを明確に記載する文を追加してください。また、2次元の矩形配列の最上位要素は行と見なされるという注記を追加することを検討してください。コードの変更は不要です。ドキュメントのテキストのみを修正する必要があります。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85