falconry/falcon

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

Open

#1,820 创建于 2020年12月17日

在 GitHub 查看
 (17 评论) (0 反应) (0 负责人)Python (9,293 star) (925 fork)batch import
documentationenhancementgood first issueneeds contributor

描述

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

贡献者指南

技术栈
python
领域
documentationdeveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python basicsunderstanding of PEP 484 type hints
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
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.
Type Hints: Add type hints to tutorials, snippets and examples · falconry/falcon#1820 | Good First Issue