Some server class attributes are missing in socketserver docs
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla documentazione di socketserver e confronta le descrizioni dei suoi attributi di classe con Lib/socketserver.py intorno alle righe 185-198. Il lavoro è completato quando allow_reuse_port è documentato, address_family è raggruppato correttamente, viene chiarito che request_queue_size si applica a TCP e viene documentato l’attributo della dimensione massima dei pacchetti riservato a UDP; gh-128320 è collegato nell’issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100