Document that we can't use new stdlib symbols until added to type-checkers
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
https://github.com/python/typeshed/pull/11890#discussion_r1597530831
An unwritten convention (because we've been bitten by it a few times in the past), is to not use newly added symbols from the stdlib stubs until all supported type-checkers (pyright, mypy, pytype??, realistically we're always waiting on mypy release because pyright releases so often) updated their vendored version of typeshed.
This is a suggestion to add this convention to the contributing guideline in a more official way, and to teach contributors about this unobvious gotcha.
Relates to #5835
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
Lies zunächst die Contributing-Richtlinie und die Diskussion in typeshed PR 11890, insbesondere den verlinkten Kommentar, um die bestehende Konvention zu verstehen. Dokumentiere, dass neu hinzugefügte Stub-Symbole der stdlib warten sollten, bis die unterstützten Type-Checker ihre vendored typeshed-Version aktualisiert haben; erledigt ist dies, wenn die Anleitung für Contributors klar ist und die relevante Richtlinie aktualisiert wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 68/100