From 52ae1ee547b528fe9fd410144ae2f3843c203485 Mon Sep 17 00:00:00 2001 From: Gustaf <79180496+gostak-dd@users.noreply.github.com> Date: Sat, 30 May 2026 19:59:42 +0200 Subject: [PATCH] gh-123138: Updated email.headerregistry docs to include required keyword parse_tree (GH-134450) (cherry picked from commit 2c20f9ce17abcbc36a105fd9de0b15797b6401ae) Co-authored-by: Gustaf <79180496+gostak-dd@users.noreply.github.com> --- Doc/library/email.headerregistry.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst index c6924a0ac29c97..619c17c98e8d89 100644 --- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -93,9 +93,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.