Plethora of Examples
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 28/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Start by reviewing the existing user guide and getting-started documentation, then compare their coverage with the NumPy documentation structure described in the issue. Use the public interface as the issue requests and relate the examples to #145. Done means expanding the sparse user guide with simple usage examples while maintaining the existing contributor guidance.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The referee for sure has a point we are lacking examples in user manual. He had an even stronger point before we were completely lacking a user manual. We simply performed the minimal task of providing something, now we should improve a lot over that something.
Being mainly a library, we want have examples of "you run this way, you'll get this output", but we need simple examples nevertheless.
As usual, NumPy is something to look at for a good pattern to imitate.
The documentation has 4 different sections: https://numpy.org/doc/
- API Reference: this we have (docstrings), for sure we can improve, but it is already good enough (the only one...)
- User Guide: we attempted to provide, but there is very little
- Getting Started: in a sense we have this and not the former one, but the truth is that we have only one out of two, with a very generic target (for us users are all the same at the moment, essentially because we have no one, so they might all be considered "Absolute Beginners")
- Contributor's Guide: not that many candidate contributors out there, but something minimal might be useful - and something we have Benchmarks and rest of "development", together with Contributing Guidelines, so we should just need to maintain it (no need to expand at the moment, we'll cross that bridge when we come to it)
Related to #145 (examples should rely on the public interface, and, if possible, "cover" it)
- Lenguaje dominante
- Python
- Estrellas
- 13
- Forks
- 9
- Merge medio
- 6 d 16 h
- PR fusionados (30 d)
- 3
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
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 NNPDF/eko
-
Update yaml reader in rustAbiertorust
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
NNPDF/eko#582 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
physics
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
physics
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
Los mantenedores suelen responder en 1 día
-
Improve Python workflowAbiertobenchmarks
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
Los mantenedores suelen responder en 1 día
-
Centralize Maturin workflowsAbiertobenchmarks rust
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
Los mantenedores suelen responder en 1 día
Issues similares
-
Layout accepts a step threshold of 0 or less, then in-toto-verify crashes with StopIterationPosiblemente ocupada @BahaaMattar la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
Los mantenedores suelen responder en 1 día
-
needs discussion
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
openfga/openfga.dev#1436 · 1 comentario ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
usb-device-hid: MouseInterface reports bInterfaceProtocol 1 (keyboard) instead of 2Posiblemente ocupada @Duhan07 la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
micropython/micropython-lib#1176 ·