dbm.whichdb docstring shows outdated return-value example
Aberta
Ninguém assumiu esta issue ainda.
docs
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Abra Lib/dbm/init.py e localize a docstring de dbm.whichdb(). Atualize seu exemplo de valor de retorno para usar os nomes de submódulos pontuados descritos na issue e, em seguida, verifique se ele corresponde aos valores documentados em Doc/library/dbm.rst.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Status de atividade
- Estagnada
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 25/100