Skip to content

email.headerregistry docs omit the required keyword parse_tree #123138

Open
@perey

Description

@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:

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:

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions