Skip to content

gh-161816: Fix documented parameter names in email.utils - #161818

Open
thejesh23 wants to merge 1 commit into
python:mainfrom
thejesh23:email-utils-doc-param-names
Open

thejesh23 wants to merge 1 commit into
python:mainfrom
thejesh23:email-utils-doc-param-names

Conversation

@thejesh23

@thejesh23 thejesh23 commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Use the real parameter names in the email.utils docs, so that keyword calls written as documented work:

  • parseaddr(): address -> addr
  • parsedate(), parsedate_tz(), parsedate_to_datetime(): date -> data
  • mktime_tz(): tuple -> data

AI disclosure: prepared with the help of Claude Code; I reviewed the change.

The documented names did not match the real ones, so passing the
argument by the documented keyword raised TypeError:

* parseaddr(): address -> addr
* parsedate(), parsedate_tz(), parsedate_to_datetime(): date -> data
* mktime_tz(): tuple -> data
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35817955 | 📁 Comparing c08b89b against main (0ada998)

  🔍 Preview build  

1 file changed
± library/email.utils.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants