josdejong/mathjs

Improve the docs for sparse matrices

Open

#1,769 opened on Mar 12, 2020

View on GitHubContributor guide
 (5 comments) (3 reactions) (0 assignees)JavaScript (1,314 forks)batch import
documentationfeaturehelp wanted

Repository metrics

Stars
 (15,065 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the current sparse matrix documentation and examples, then identify gaps. Create a step by step guide with real world use cases, covering creation, manipulation, and common operations. Ensure examples are runnable and clearly explained.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75