]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-123138: Updated email.headerregistry docs to include required keyword parse_tree...
authorGustaf <79180496+gostak-dd@users.noreply.github.com>
Sat, 30 May 2026 17:59:42 +0000 (19:59 +0200)
committerGitHub <noreply@github.com>
Sat, 30 May 2026 17:59:42 +0000 (20:59 +0300)
Doc/library/email.headerregistry.rst

index c6924a0ac29c972572552d3bbdb99067bb75ac65..619c17c98e8d89c5a95686e023d9a8fd6f84946c 100644 (file)
@@ -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.