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.