josdejong/mathjs

Improve the docs for sparse matrices

Open

#1769 aperta il 12 mar 2020

Vedi su GitHub
 (5 commenti) (3 reazioni) (0 assegnatari)JavaScript (1298 fork)batch import
documentationfeaturehelp wanted

Metriche repository

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

Descrizione

It is almost impossible to learn how to use SparseMatrix from the current documentation. The example code also isn't very useful. We need to improve the documentation and make it easier to grasp and include some real-world examples.

(Possibly related to #1166 and #1770?)

Guida contributor

Direzione di ricerca
Esamina la documentazione e gli esempi attuali delle matrici sparse, quindi identifica le lacune. Crea una guida passo passo con casi d'uso reali, coprendo creazione, manipolazione e operazioni comuni. Assicurati che gli esempi siano eseguibili e spiegati chiaramente.
Tech stack
javascriptnodejs
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
GitJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75