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

Ouverte Adaptée aux débutants
#1,493 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
python
Domaine
documentation

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.

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

Langage dominant
Python
Étoiles
1.7k
Forks
408
Merge moyen
2 j 57 min
PR mergées (30 j)
7

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de libgit2/pygit2

Toutes les issues de libgit2/pygit2

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.