falconry/falcon

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

開放

#1,820 建立於 2020年12月17日

在 GitHub 查看貢獻者指南
 (17 則留言) (0 個反應) (0 位負責人)Python (925 個分叉)batch import
documentationenhancementgood first issueneeds contributor

倉庫指標

星標
 (9,293 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南

研究方向
審查倉庫中的教程和範例文件，按照PEP 484慣例在函式簽名和變數宣告中添加型別註解。從連結的拉取請求討論中列出的檔案開始。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonType hints
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80