Overview documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Compare the crates.io entry with the ndarray module documentation linked in the issue, then review the ArrayBase page for material that should remain detailed. Organize the module overview around what the library does, core examples, design ideas, and links to the main types and traits. Done means the overview gives newcomers a clear starting point without duplicating reference details.
Written by the indexing model from the issue text.
Description
I at least often find myself wondering "does ndarray support this? where should I look for it?".
ndarray has not bad reference documentation, but not enough of an overview that points into the reference.
I think overview documentation should explain as soon as possible what the library does, give examples of use of the core features, and relate the core design ideas necessary for using it (including linking to any terms that are going to come up, including the main types, traits etc. The crates.io entry [1] does the first well, but the module documentation [2] is a bit mixed up:
- Mentions N-dim array
- Skips forward to defining some main types (without explaining the design)
- Goes back to state the core features (no examples, though)
I would put all of the overview information in the module docs, leaving details to e.g., the ArrayBase page.
[1] https://crates.io/crates/ndarray
[2] https://bluss.github.io/rust-ndarray/master/ndarray/index.html
- Dominant language
- Rust
- Stars
- 4.3k
- Forks
- 391
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rust-ndarray/ndarray
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
rust-ndarray/ndarray#1612 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
rust-ndarray/ndarray#1617 · 1 comment ·
-
bug good first issue
Difficulty 3/5 1-2 days Newbie friendliness 68/100
rust-ndarray/ndarray#1615 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
rust-ndarray/ndarray#1610 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
rust-ndarray/ndarray#1609 ·
All issues in rust-ndarray/ndarray
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100