python / python/cpython

dbm.whichdb docstring shows outdated return-value example

オープン
#153,305 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. 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 を短くまとめたダイジェスト。