Some server class attributes are missing in socketserver docs
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 36k
- Métriques de merge des PR
- Métriques de PR en attente
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la documentation de socketserver et comparez les descriptions de ses attributs de classe avec Lib/socketserver.py autour des lignes 185-198. Le travail est considéré comme terminé lorsque allow_reuse_port est documenté, que address_family est correctement regroupé, qu’il est précisé que request_queue_size s’applique à TCP et que l’attribut de taille maximale de paquet propre à UDP est documenté ; gh-128320 est lié dans l’issue.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100