josdejong/mathjs

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

Offen

#2.618 geöffnet am 06.07.2022

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (1.314 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (15.065 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Das Issue fordert, dass die Dokumentation für 'math.multiply' aktualisiert wird, um explizit anzugeben, dass sie für Matrizen eine Prämultiplikation durchführt. Derzeit impliziert die Beschreibung für andere Typen eine Postmultiplikation, was zu Verwirrung führt. Um dies zu beheben, überprüfen Sie die vorhandene Dokumentation unter https://mathjs.org/docs/reference/functions/multiply.html und fügen Sie eine klare Aussage hinzu, dass für Matrixargumente die Operation eine Prämultiplikation ist (d.h., 'math.multiply(a, b)' berechnet ab, wobei a von b linksmultipliziert wird). Erwägen Sie auch, einen Hinweis hinzuzufügen, dass die obersten Elemente eines 2D rechteckigen Arrays als Zeilen betrachtet werden. Keine Codeänderungen sind erforderlich; nur der Dokumentationstext muss angepasst werden.
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85