falconry/falcon

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

Open

#1820 aperta il 17 dic 2020

Vedi su GitHub
 (17 commenti) (0 reazioni) (0 assegnatari)Python (925 fork)batch import
documentationenhancementgood first issueneeds contributor

Metriche repository

Star
 (9293 star)
Metriche merge PR
 (Merge medio 2g 7h) (9 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i file di tutorial ed esempi nel repository e aggiungi annotazioni di tipo alle firme delle funzioni e alle dichiarazioni di variabili seguendo le convenzioni PEP 484. Inizia con i file elencati nella discussione della pull request collegata.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonType hints
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80