dbm.whichdb docstring shows outdated return-value example
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open Lib/dbm/init.py and locate the dbm.whichdb() docstring. Update its return-value example to use the dotted submodule names described in the issue, then verify it matches the values documented in Doc/library/dbm.rst.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100