falconry/falcon

Type Hints: Add type hints to tutorials, snippets and examples

Aberta

#1.820 aberto em 17 de dez. de 2020

Ver no GitHubGuia do colaborador
 (17 comentários) (0 reação) (0 responsável)Python (925 forks)batch import
documentationenhancementgood first issueneeds contributor

Métricas do repositório

Stars
 (9.293 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

To improve code readability and be friendlier to PEP 484, we should start adding type annotations to our code, probably starting from snippets, tutorials and examples.

Originally discussed here https://github.com/falconry/falcon/pull/1737#issuecomment-744064360

Guia do colaborador

Direção de pesquisa
Revise os arquivos de tutorial e exemplos no repositório e adicione anotações de tipo às assinaturas de funções e declarações de variáveis seguindo as convenções PEP 484. Comece pelos arquivos listados na discussão do pull request vinculado.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonType hints
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80