Documented parameter names of some email.utils functions don't match the implementation

未關閉
#161,816 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
1/5
預估耗時
1-3 小時
新手友好度
20/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
停滯
技術堆疊
python
領域
documentation

研究方向

The issue identifies the email.utils documentation and the affected functions: parseaddr(), parsedate(), parsedate_tz(), parsedate_to_datetime(), and mktime_tz(). Compare their documented parameter names with the implementation, then update the docs and check that each name matches; the issue body also lists linked PR gh-161818, so the work may already be underway.

由索引模型根據 Issue 內容生成。

描述

docs topic-email

Documentation

A few functions in the email.utils docs show a parameter name that differs from the real one. Anyone copying the name from the docs gets a TypeError:

>>> from email.utils import parsedate
>>> parsedate(date='Mon, 20 Nov 1995 19:12:08 -0500')
TypeError: parsedate() got an unexpected keyword argument 'date'. Did you mean 'data'?
>>> parsedate(data='Mon, 20 Nov 1995 19:12:08 -0500')
(1995, 11, 20, 19, 12, 8, 0, 1, -1)
Function Docs Code
parseaddr() address addr
parsedate(), parsedate_tz(), parsedate_to_datetime() date data
mktime_tz() tuple data
Linked PRs
  • gh-161818
主要語言
Python
星號
78.2k
分支
36.6k
平均合併
19 小時 57 分鐘
30 天內合併 PR
630

環境準備

在 Codespaces 中開啟

在瀏覽器裡用你自己的 GitHub 帳號啟動這個專案的開發容器。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

python/cpython 的其他 Issue

查看 python/cpython 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。