python / python/cpython

dbm.whichdb docstring shows outdated return-value example

Aperta
#153,305 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Apri Lib/dbm/init.py e individua la docstring di dbm.whichdb(). Aggiorna il relativo esempio del valore restituito in modo che utilizzi i nomi dei sottomoduli puntati descritti nell’issue, quindi verifica che corrisponda ai valori documentati in Doc/library/dbm.rst.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.