Mismatch behaviour in documentation of `email.Message.defects`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked email.message.EmailMessage.defects documentation and the referenced email.errors page, then review the related issues about header defects. Done means the documentation accurately states that defects in message headers are not included in email.Message.defects until those issues are fixed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100