python / python/cpython

Some server class attributes are missing in socketserver docs

Abierto
#128,319 0 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs topic-socket
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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.

https://github.com/python/cpython/blob/f9a5a3a3ef34e63dc197156e9a5f57842859ca04/Lib/socketserver.py#L185-L198

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la documentación de socketserver y compara las descripciones de sus atributos de clase con Lib/socketserver.py alrededor de las líneas 185-198. Se considera completado cuando se documente allow_reuse_port, se agrupe correctamente address_family, se aclare que request_queue_size se aplica a TCP y se documente el atributo de tamaño máximo de paquete exclusivo de UDP; gh-128320 está enlazado en el issue.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.