josdejong/mathjs

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

Open

#2,618 opened on Jul 6, 2022

View on GitHubContributor guide
 (8 comments) (1 reaction) (0 assignees)JavaScript (1,314 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (15,065 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Read the current documentation on matrix multiplication and the concept of rows/columns in matrices. Propose wording changes to explicitly state that the first dimension corresponds to rows.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85