falconry/falcon

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

Open

#1,820 opened on Dec 17, 2020

View on GitHub
 (17 comments) (0 reactions) (0 assignees)Python (925 forks)batch import
documentationenhancementgood first issueneeds contributor

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (Avg merge 2d 7h) (9 merged PRs in 30d)

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

Contributor guide

Research direction
Review the tutorial and example files in the repository and add type annotations to function signatures and variable declarations following PEP 484 conventions. Start with the files listed in the linked pull request discussion.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonType hints
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80