josdejong/mathjs

Improve the docs for sparse matrices

Open

#1,769 opened on Mar 12, 2020

View on GitHub
 (5 comments) (3 reactions) (0 assignees)JavaScript (13,832 stars) (1,298 forks)batch import
documentationfeaturehelp wanted

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

Tech stack
javascript
Domain
documentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScript knowledgeFamiliarity with mathjs library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the existing sparse matrix documentation and examples links. Identify missing details and write clear explanations with real world examples. Check related issues #1166 and #1770 for context.