Stubtest docs: common failure/suppression examples + debugging guidance
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 5.1k
- Forks
- 2.1k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 82
Beschreibung
I feel like the contributing guide could benefit from instructions around debugging stubtest failures, and examples of things that stubtest can't handle that would warrant suppressions.
The mypy stubtest docs don't really go into enough detail or have enough examples, which makes it harder for new contributors (like myself) to debug failures.
Maybe we could improve that doc and link to it from CONTRIBUTING.md. I think that would reduce the need for maintainers to help stub contributors debug these failures, and make things a bit more self-service.
I'm happy to contribute to this, though I'm a bit too new to know which specific patterns are commonly suppressed.
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
Beginne mit CONTRIBUTING.md und der verlinkten mypy-stubtest-Dokumentation und ermittle anschließend, wo Anleitungen zum Debuggen und Unterdrücken von stubtest-Fehlern hingehören. Erledigt ist die Aufgabe, wenn häufige Fehler- und Unterdrückungsbeispiele hinzugefügt, die Fehlersuche bei Fehlern erklärt und die verbesserte Dokumentation von CONTRIBUTING.md aus verlinkt wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, testing-qa
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 52/100