Document all array creation methods in one place

Open
#1,218 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start with the linked ndarray for numpy users documentation section on rough NumPy equivalents, then review the ndarray API for array-construction methods such as zeros, linspace, and logspace. Add a main-documentation section that lists and briefly describes all relevant creation methods, with coverage of the available methods as the completion check.

Written by the indexing model from the issue text.

Description

docs

There's some nice docs on array creation in the ndarray for numpy docs, but it would be nice if there was a separate section in the main documentation that listed and briefly described all the ndarray methods for creating new arrays, e.g. zeros, linsapce, logspace etc.

Dominant language
Rust
Stars
4.3k
Forks
391
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-ndarray/ndarray

All issues in rust-ndarray/ndarray

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.