josdejong/mathjs

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

Open

#2 618 ouverte le 6 juil. 2022

Voir sur GitHub
 (8 commentaires) (1 réaction) (0 assignés)JavaScript (1 298 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (13 832 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Le ticket demande que la documentation de 'math.multiply' soit mise à jour pour indiquer explicitement qu'elle effectue une pré multiplication pour les matrices. Actuellement, la description implique une post multiplication pour d'autres types, ce qui entraîne une confusion. Pour résoudre ce problème, examinez la documentation existante à l'adresse https://mathjs.org/docs/reference/functions/multiply.html et ajoutez une déclaration claire indiquant que pour les arguments de type matrice, l'opération est une pré multiplication (c'est à dire que 'math.multiply(a, b)' calcule ab où a est multiplié à gauche par b). Envisagez également d'ajouter une note précisant que les éléments de niveau supérieur d'un tableau rectangulaire 2D sont considérés comme des lignes. Aucune modification de code n'est nécessaire ; seul le texte de la documentation doit être modifié.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85