Documentation code blocks should be type checked as real tests
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 20.6k
- Forks
- 3.3k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Es werden keine Dateien, Tests oder Einstiegspunkte genannt. Beginne damit, herauszufinden, wie Codeblöcke in der Dokumentation derzeit getestet werden, und ermittle dann, wie sie als echte Tests auf Typkorrektheit geprüft werden könnten. Als erledigt gilt die Aufgabe, wenn die Beispiele in der Dokumentation auf Gültigkeit geprüft werden und das verknüpfte Issue dazu, dass Beispiele keine echten Fehler verwenden, behoben ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, testing-qa
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100