python / python/cpython

Mismatch behaviour in documentation of `email.Message.defects`

Abierto
#128,568 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

Documentation

https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.defects

The defects attribute contains a list of all the problems found when parsing this message. See email.errors for a detailed description of the possible parsing defects.


It actually does not include defects in the message headers (#106144, #90169). Until these issues are fixed, the documentation should state that header defects are not included in email.Message.defects.

Linked PRs
  • gh-128569

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 enlazada de email.message.EmailMessage.defects y la página email.errors referenciada; después, revisa las issues relacionadas con los defectos de las cabeceras. El trabajo está terminado cuando la documentación indique correctamente que los defectos en las cabeceras de los mensajes no se incluyen en email.Message.defects hasta que se solucionen esas issues.

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
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.