Documentation code blocks should be type checked as real tests
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Feature
Ideally, if anyone has the time, documentation code blocks should be type checked as real tests
Pitch
This will ensure that the examples stay up to date and valid; provide an obvious home for basic test coverage where it can also inform the user; and, as an added bonus, necessarily implies fixing the issue about how the documentation test examples don't use real errors.
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
Non vengono indicati file, test o punti di ingresso. Inizia individuando come vengono attualmente testati i blocchi di codice della documentazione, quindi determina come potrebbero essere sottoposti a controllo dei tipi come veri test. Il lavoro è completato quando gli esempi della documentazione vengono verificati per accertarne la validità e viene risolta l’issue collegata relativa al fatto che gli esempi non usano errori reali.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation, testing-qa
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100