Mismatch behaviour in documentation of `email.Message.defects`
オープン
まだ誰も着手していません。
docs
topic-email
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされている email.message.EmailMessage.defects のドキュメントと、参照されている email.errors のページから始め、その後、ヘッダーの欠陥に関する関連 issue を確認します。完了条件は、これらの issue が修正されるまで、メッセージヘッダーの欠陥が email.Message.defects に含まれないことをドキュメントが正確に記載していることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 25/100