cloudevents / cloudevents/sdk-python
Improve in-code documentation
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 342
- Fork
- 65
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
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 esaminando la codebase Python alla ricerca di pydocs mancanti e verificando le PRs proposte menzionate nella issue. L’ambito comprende la documentazione e gli esempi in quasi tutto il codice, oltre a una policy per prevenire PRs non documentate. Per considerarlo completato sarebbero necessari un approccio condiviso e un’ampia copertura della documentazione mancante.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100