josdejong/mathjs

Improve the docs for sparse matrices

Offen

#1.769 geöffnet am 12.03.2020

Auf GitHub ansehenContributor Guide
 (5 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)JavaScript (1.314 Forks)batch import
documentationfeaturehelp wanted

Repository-Metriken

Stars
 (15.065 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die aktuelle Dokumentation und Beispiele für dünnbesetzte Matrizen und identifizieren Sie Lücken. Erstellen Sie eine Schritt für Schritt Anleitung mit realen Anwendungsfällen, die Erstellung, Manipulation und gängige Operationen abdeckt. Stellen Sie sicher, dass die Beispiele ausführbar und klar erklärt sind.
Tech Stack
javascriptnodejs
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75