Plethora of Examples

Abierto
#147 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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

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

documentation good first issue

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/

  1. API Reference: this we have (docstrings), for sure we can improve, but it is already good enough (the only one...)
  2. User Guide: we attempted to provide, but there is very little
  3. 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")
  4. 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

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NNPDF/eko

Todos los issues de NNPDF/eko

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.