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