falconry/falcon

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

Ouverte

#1 820 ouverte le 17 déc. 2020

Voir sur GitHubGuide contributeur
 (17 commentaires) (0 réaction) (0 personne assignée)Python (925 forks)batch import
documentationenhancementgood first issueneeds contributor

Métriques du dépôt

Stars
 (9 293 étoiles)
Métriques de merge PR
 (Merge moyen 2j 7h) (9 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez les fichiers de tutoriels et d'exemples dans le dépôt et ajoutez des annotations de type aux signatures de fonctions et aux déclarations de variables conformément aux conventions PEP 484. Commencez par les fichiers listés dans la discussion de la pull request liée.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonType hints
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80