docs: submodule documentation doesn't mention that SubmoduleCollection is a sequence of Submodule instances
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 1.7k
- Forks
- 408
- Merge moyen
- 2 j 57 min
- PR mergées (30 j)
- 7
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la documentation de Submodule à l’adresse pygit2.org/submodule.html et comparez sa liste de méthodes avec la documentation de Trees à l’adresse pygit2.org/objects.html#trees. Documentez que SubmoduleCollection est une séquence d’instances de Submodule, y compris le comportement de getitem et iter ; le travail est terminé lorsque les utilisateurs peuvent voir comment itérer sur tous les sous-modules.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- Active
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 88/100