Introductory documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- rust
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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?
- Lenguaje dominante
- Rust
- Estrellas
- 4.3k
- Forks
- 391
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de rust-ndarray/ndarray
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
rust-ndarray/ndarray#1612 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
rust-ndarray/ndarray#1617 · 1 comentario ·
-
Stack overflow in `triu` Abiertobug good first issue
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
rust-ndarray/ndarray#1615 · 1 comentario ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
rust-ndarray/ndarray#1610 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
rust-ndarray/ndarray#1609 ·
Todos los issues de rust-ndarray/ndarray
Issues similares
-
risk:low runtime status:in-progress type:test
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
zeroclaw-labs/zeroclaw#11023 ·
-
good first issue refactor
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
EricSpencer00/Resilient#4835 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
bisq-network/bisq-musig#204 ·
-
agent:ready documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
cesarferreira/stax#890 ·