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 摘要。