josdejong/mathjs

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

Open

#2.618 aberto em 6 de jul. de 2022

Ver no GitHub
 (8 comments) (1 reaction) (0 assignees)JavaScript (1.298 forks)batch import
documentationhelp wanted

Métricas do repositório

Stars
 (13.832 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Guia do colaborador

Direção de pesquisa
A issue solicita que a documentação de 'math.multiply' seja atualizada para declarar explicitamente que ela realiza pré multiplicação para matrizes. Atualmente, a descrição implica pós multiplicação para outros tipos, causando confusão. Para resolver isso, revise a documentação existente em https://mathjs.org/docs/reference/functions/multiply.html e adicione uma declaração clara de que, para argumentos de matriz, a operação é pré multiplicação (ou seja, 'math.multiply(a, b)' calcula ab onde a é multiplicado à esquerda por b). Considere também adicionar uma nota de que os elementos de nível superior de um array retangular 2D são considerados linhas. Nenhuma alteração de código é necessária; apenas o texto da documentação precisa ser modificado.
Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85