Argument Clinic: add reference for all directives
Aberta
Ninguém assumiu esta issue ainda.
type-feature
- Linguagem predominante
- Python
- Estrelas
- 2.1k
- Forks
- 1k
- Merge médio
- 2d 12h
- PRs com merge (30d)
- 12
Descrição
We need a good reference for all Argument Clinic directives (@getter, output, etc.). Some of the directives accept one or more parameters; perhaps we can use typical CLI documentation for inspiration (@critical_section [arg1] [arg2]).
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 localizando a documentação existente do Argument Clinic e as definições atuais das diretivas. Faça um inventário de todas as diretivas, incluindo as que têm parâmetros, e compare a sintaxe delas com o exemplo no estilo CLI da issue. O trabalho estará concluído quando o devguide fornecer uma referência clara que abranja cada diretiva e seus parâmetros aceitos.
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
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100