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 (9,293 stars) (925 forks)batch import
documentationenhancementgood first issueneeds contributor

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

Tech stack
python
Domain
documentationdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsunderstanding of PEP 484 type hints
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue asks to add type hints to tutorials, snippets, and examples in the Falcon repository. Start by exploring the /docs directory and any example files to identify which code snippets lack type annotations. The originally linked PR #1737 discussion (https://github.com/falconry/falcon/pull/1737#issuecomment 744064360) provides context on the approach. Focus on adding type hints to functions and methods in these files, following PEP 484 conventions. No existing PRs or assignments were found, so this is open for contribution.