Introductory documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- rust
- Ambito
- documentation
Direzione di ricerca
Start by reviewing the existing reference documentation, the concerns in issues #160 and #327, and the ndarray for NumPy users guide cited in the issue. Done would be a separate high-level overview that explains ndarray's structure and design principles while gradually introducing the library to newcomers.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I was reasoning around this during the last few days while working on my PRs (and reading some issues like #160): it is really complicated to get a good overview of the way ndarray is structured solely relying on the reference documentation. It is even more complicated when the method you are looking at calls functions that are annotated with #[doc(hidden)] (it happens quite often in the core structs and traits implementations)
Without @jturner314's ndarray for NumPy users it would have taken me at least twice as long to reach my current level of understanding (which is still very partial). This echoes #327, for instance.
Would it be of interest to produce some kind of separate documentation, similar in spirit to http://nalgebra.org/ for nalgebra or http://scikit-learn.org/stable/ for scikit-learn?
A high-level overview of the overall crate, aimed at explaining the underlying design principles, gradually introducing a newcomer to the library.
I would be happy to work on it, at least to further my own understanding of ndarray.
What are your thoughts on the matter @bluss?
- Lingua principale
- Rust
- Stelle
- 4.3k
- Fork
- 391
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di rust-ndarray/ndarray
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
rust-ndarray/ndarray#1612 · 1 commento ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
rust-ndarray/ndarray#1617 · 1 commento ·
-
Stack overflow in `triu` Apertabug good first issue
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
rust-ndarray/ndarray#1615 · 1 commento ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
rust-ndarray/ndarray#1610 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
rust-ndarray/ndarray#1609 ·