Make documentation clearer that the top-level elements of a 2D rectangular array are considered **rows** of matrices. · josdejong/mathjs#2618

(8 comments) (1 reaction) (0 assignees)JavaScript (13,832 stars) (1,298 forks)batch import

documentationhelp wanted

Description

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! :)

Contributor guide

Tech stack: javascript
Domain: documentation
Issue type: documentation
Difficulty: 2
Estimated time: under 1 hour
Activity status: fresh
Clarity: clear
Prerequisites: None
Newbie friendliness: 85
Research direction: The issue requests that the documentation for 'math.multiply' be updated to explicitly state that it performs pre multiplication for matrices. Currently, the description implies post multiplication for other types, leading to confusion. To address this, review the existing documentation at https://mathjs.org/docs/reference/functions/multiply.html and add a clear statement that for matrix arguments, the operation is pre multiplication (i.e., 'math.multiply(a, b)' computes ab where a is left multiplied by b). Also consider adding a note that the top level elements of a 2D rectangular array are considered rows. No code changes are necessary; only documentation text needs modification.