josdejong/mathjs

Improve the docs for sparse matrices

Ouverte

#1 769 ouverte le 12 mars 2020

Voir sur GitHubGuide contributeur
 (5 commentaires) (3 réactions) (0 personne assignée)JavaScript (1 314 forks)batch import
documentationfeaturehelp wanted

Métriques du dépôt

Stars
 (15 065 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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?)

Guide contributeur

Direction de recherche
Examinez la documentation et les exemples actuels des matrices creuses, puis identifiez les lacunes. Créez un guide étape par étape avec des cas d'utilisation réels, couvrant la création, la manipulation et les opérations courantes. Assurez vous que les exemples sont exécutables et clairement expliqués.
Stack technique
javascriptnodejs
Domaine
backend
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.
Une demi journée
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
GitJavaScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75