python / python/cpython

dbm.whichdb docstring shows outdated return-value example

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

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
35.9k
PR 合併指標
PR 指標待擷取

描述

dbm.whichdb() returns the dotted submodule name, such as "dbm.ndbm" or
"dbm.gnu" (these are the keys of the internal _modules dispatch table, and
the values documented in Doc/library/dbm.rst).

The function docstring in Lib/dbm/__init__.py still shows the pre-package
form:

- the name of the dbm submodule (e.g. "ndbm" or "gnu") if recognized.

The example should use the actual dotted names, to match the code and the
documentation.

Linked PRs
  • gh-153306

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

開啟 Lib/dbm/init.py 並找到 dbm.whichdb() 的 docstring。更新其回傳值範例,使其使用 issue 中描述的點號分隔子模組名稱,然後確認它是否與 Doc/library/dbm.rst 中記載的值相符。

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

評估

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

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

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