From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 2 Jun 2026 09:26:18 +0000 (+0200)
Subject: [3.13] gh-123138: Updated email.headerregistry docs to include required keyword parse... 
X-Git-Url: http://git.ipfire.org/gitweb/index.cgi?a=commitdiff_plain;h=7d1998d2d5c5daa16eb9e0e8c2d4d0a577aa67e0;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-123138: Updated email.headerregistry docs to include required keyword parse_tree (GH-134450) (GH-150625)

(cherry picked from commit 2c20f9ce17abcbc36a105fd9de0b15797b6401ae)

Co-authored-by: Gustaf <79180496+gostak-dd@users.noreply.github.com>
---

diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst
index ff8b601fe3d1..c4570b16c3c3 100644
--- a/Doc/library/email.headerregistry.rst
+++ b/Doc/library/email.headerregistry.rst
@@ -96,9 +96,10 @@ headers.
    ``kwds`` is a dictionary containing one pre-initialized key, ``defects``.
    ``defects`` is an empty list.  The parse method should append any detected
    defects to this list.  On return, the ``kwds`` dictionary *must* contain
-   values for at least the keys ``decoded`` and ``defects``.  ``decoded``
-   should be the string value for the header (that is, the header value fully
-   decoded to unicode).  The parse method should assume that *string* may
+   values for at least the keys ``decoded``, ``defects`` and ``parse_tree``.
+   ``decoded`` should be the string value for the header (that is, the header
+   value fully decoded to unicode). ``parse_tree`` is set to the parse tree obtained
+   from parsing the header. The parse method should assume that *string* may
    contain content-transfer-encoded parts, but should correctly handle all valid
    unicode characters as well so that it can parse un-encoded header values.