`email.headerregistry` docs omit the required keyword `parse_tree`

[perey]

Documentation

The documentation for the email.headerregistry module say that the parse() method of custom header classes must ensure that kwds contains the keys decoded and defects:

cpython/Doc/library/email.headerregistry.rst

Line 99 in 8edfa0b

values for at least the keys ``decoded`` and ``defects``. ``decoded``

However, there is a third key required, parse_tree, as mentioned in the source code:

cpython/Lib/email/headerregistry.py

Line 165 in 8edfa0b

the dictionary must contain two additional keys: parse_tree, set to the

The documentation should mention this required key as well. Ideally, it would also explain what its content should be.

Linked PRs

• gh-123138: Updated email.headerregistry docs to include required keyword parse_tree #134450