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

Aperta Adatta ai principianti
#1,493 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

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.

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

Lingua principale
Python
Stelle
1.7k
Fork
408
Merge medio
2g 57m
PR unite (30g)
7

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di libgit2/pygit2

Tutte le issue di libgit2/pygit2

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.