Argument Clinic: add reference for all directives

Aberta
#1,269 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

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.

Descrição

type-feature

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]).

Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de python/devguide

Todas as issues de python/devguide

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.