Some server class attributes are missing in socketserver docs
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
While working with socketserver recently I noticed that the allow_reuse_port class attribute is not documented but the allow_reuse_address attribute is.
In addition there's a couple of places we could clean up right now, for instance address_family is still grouped with the per-instance attributes rather than the class attributes, request_queue_size is only applicable to TCP, and there's another missing undocumented class attribute for specifying max packet size that is only applicable to UDP.
Linked PRs
- gh-128320
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 der socketserver-Dokumentation und vergleiche deren Beschreibungen der Klassenattribute mit Lib/socketserver.py im Bereich der Zeilen 185-198. Als erledigt gilt die Dokumentation von allow_reuse_port, die korrekte Gruppierung von address_family, die Klarstellung, dass request_queue_size für TCP gilt, sowie die Dokumentation des nur für UDP geltenden Attributs für die maximale Paketgröße; gh-128320 ist im Issue verlinkt.
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
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100