testcontainers / testcontainers/testcontainers-python

Improve DockerCompose documentation

Abierto
#165 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

🐣 good first issue 📖 documentation 🛟 help wanted
Lenguaje dominante
Python
Estrellas
2.3k
Forks
386
Merge medio
4 h 40 min
PR fusionados (30 d)
1

Descripción

Hi. I'm starting to use testcontainers to test the behavior of a simple P2P network written in Python. I noticed that the auto-generated documentation for each class is just a copy of the constructor (without parameters descriptions) and a small code example. It would be really helpful if, at least, a small description of the behavior of each available method for each class was provided. Then this could be improved by adding a small description of the meaning of each parameter.

Small addition: for some reason, the documentation has really big margins on the left and the right but the title is too long.
Screenshot (113)

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Comienza con la documentación generada enlazada en el issue y localiza la clase DockerCompose y sus páginas de métodos. Revisa cómo se genera y se aplica el estilo a la documentación antes de documentar el comportamiento de los métodos y el significado de los parámetros; el trabajo estará terminado cuando las páginas expliquen los métodos y parámetros disponibles y se hayan corregido los márgenes excesivos y el título demasiado largo.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
docker-compose, python
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.