Intra-package References Documentation Incomplete
Aberta
Ninguém assumiu esta issue ainda.
docs
type-bug
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
| BPO | 35927 |
|---|---|
| Nosy | @brettcannon, @terryjreedy, @ncoghlan, @ericsnowcurrently |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2019-02-07.04:38:30.393>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = 'Intra-package References Documentation Incomplete'
updated_at = <Date 2019-02-14.00:38:19.737>
user = 'https://bugs.python.org/ADataGman'
bugs.python.org fields:
activity = <Date 2019-02-14.00:38:19.737>
actor = 'ADataGman'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-02-07.04:38:30.393>
creator = 'ADataGman'
dependencies = []
files = ['48109']
hgrepos = []
issue_num = 35927
keywords = []
message_count = 7.0
messages = ['335002', '335104', '335105', '335126', '335303', '335385', '335486']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'terry.reedy', 'ncoghlan', 'docs@python', 'eric.snow', 'ADataGman']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35927'
versions = ['Python 3.7', 'Python 3.8']
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
Comece lendo a issue 35927 do BPO vinculada e inspecionando sound.zip, o exemplo de código copiado da documentação. Identifique quais referências intrapacote estão ausentes ou incompletas na documentação relevante do Python. Considera-se concluído quando a documentação cobrir completamente as referências demonstradas pelo exemplo e as verificações apropriadas da documentação forem aprovadas.
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
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 35/100