python / python/cpython

socket.recvfrom(): docs should warn about packet truncation when bufsize is insufficient

Abierto
#78,798 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

3.7 (EOL) 3.8 (EOL) docs topic-socket type-feature
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

BPO 34617
Nosy @aneesahmed777

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2018-09-09.22:21:11.308>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'socket.recvfrom(): docs should warn about packet truncation when bufsize is insufficient'
updated_at = <Date 2018-09-09.22:21:11.308>
user = 'https://github.com/aneesahmed777'

bugs.python.org fields:

activity = <Date 2018-09-09.22:21:11.308>
actor = 'Anees Ahmed'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-09-09.22:21:11.308>
creator = 'Anees Ahmed'
dependencies = []
files = []
hgrepos = []
issue_num = 34617
keywords = []
message_count = 1.0
messages = ['324901']
nosy_count = 2.0
nosy_names = ['docs@python', 'Anees Ahmed']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34617'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8']

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 localizando la documentación de Python para socket.recvfrom() y revisa cómo se describen su argumento bufsize y los datos del paquete devueltos. Actualiza la documentación para advertir que un bufsize insuficiente puede truncar el paquete y, después, comprueba la documentación renderizada para verificar que la redacción sea clara y precisa.

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
38/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.