docs: submodule documentation doesn't mention that SubmoduleCollection is a sequence of Submodule instances

Abierto Apto para principiantes
#1,493 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza con la documentación de Submodule en pygit2.org/submodule.html y compara su lista de métodos con la documentación de Trees en pygit2.org/objects.html#trees. Documenta que SubmoduleCollection es una secuencia de instancias de Submodule, incluido el comportamiento de getitem y iter; se habrá terminado cuando los usuarios puedan ver cómo iterar sobre todos los submódulos.

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

Descripción

I spent a few minutes going over https://www.pygit2.org/submodule.html trying to understand how to get all the submodules from a SubmoduleCollection. It turns out that you can just iterate over it. I think it would be good if the documentation mentioned it (perhaps listing __getitem__ and __iter__ in the list of methods, as is the case in https://www.pygit2.org/objects.html#trees).

Thanks!
Noam

Lenguaje dominante
Python
Estrellas
1.7k
Forks
408
Merge medio
2 d 57 min
PR fusionados (30 d)
7

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.

Más de libgit2/pygit2

Todos los issues de libgit2/pygit2

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.