docs: submodule documentation doesn't mention that SubmoduleCollection is a sequence of Submodule instances
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 408
- Merge medio
- 2g 57m
- PR unite (30g)
- 7
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con la documentazione di Submodule all’indirizzo pygit2.org/submodule.html e confronta il relativo elenco dei metodi con la documentazione di Trees all’indirizzo pygit2.org/objects.html#trees. Documenta che SubmoduleCollection è una sequenza di istanze di Submodule, incluso il comportamento di getitem e iter; il lavoro è completato quando gli utenti possono vedere come iterare su tutti i sottomoduli.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Stato di attività
- Attiva
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 88/100