Advise to use typing.IO sparingly
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
typing.IO and subclasses typing.TextIO and typing.BinaryIO are a bit of a legacy feature and should be used sparingly. We should document better alternatives. I'm preparing a PR with some suggestions.
(Cc @gvanrossum @JelleZijlstra @AlexWaygood)
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
Das Issue betrifft die Dokumentation für typing.IO, typing.TextIO und typing.BinaryIO, nennt jedoch keine Dateien, Tests oder einen Einstiegspunkt in die Dokumentation. Beginne damit, die relevante typing-Dokumentation zu finden und die vom Reporter vorbereiteten Alternativen zu prüfen. Als erledigt gilt die Aufgabe, wenn die Dokumentation klar erläutert, wann diese Typen sparsam verwendet werden sollten, und bessere Alternativen aufzeigt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100