josdejong/mathjs

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

Open

#2618 aperta il 6 lug 2022

Vedi su GitHub
 (8 commenti) (1 reazione) (0 assegnatari)JavaScript (1298 fork)batch import
documentationhelp wanted

Metriche repository

Star
 (13.832 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
La segnalazione richiede di aggiornare la documentazione per 'math.multiply' per dichiarare esplicitamente che esegue la pre moltiplicazione per le matrici. Attualmente, la descrizione implica la post moltiplicazione per altri tipi, causando confusione. Per risolvere questo problema, rivedere la documentazione esistente all'indirizzo https://mathjs.org/docs/reference/functions/multiply.html e aggiungere un'istruzione chiara che per gli argomenti matrice, l'operazione è una pre moltiplicazione (ovvero, 'math.multiply(a, b)' calcola ab dove a è moltiplicato a sinistra per b). Considerare inoltre di aggiungere una nota che gli elementi di primo livello di un array rettangolare 2D sono considerati righe. Non sono necessarie modifiche al codice; è sufficiente modificare il testo della documentazione.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85