python / python/cpython

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

Aberta
#128,568 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs topic-email
Linguagem predominante
Python
Estrelas
77.2k
Forks
35.9k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela documentação vinculada de email.message.EmailMessage.defects e pela página email.errors referenciada; em seguida, revise as issues relacionadas a defeitos nos cabeçalhos. O trabalho estará concluído quando a documentação declarar corretamente que os defeitos nos cabeçalhos das mensagens não são incluídos em email.Message.defects até que essas issues sejam corrigidas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.