falconry/falcon

Consider moving all the tutorial code to files, having not only the final version there

Open

#2,247 建立於 2024年7月13日

在 GitHub 查看
 (8 留言) (0 反應) (0 負責人)Python (9,293 star) (925 fork)batch import
documentationgood first issuemaintenance

描述

At the moment only the final version of the tutorials is in the example folder, while the intermediate code is pasted into the rst files.

It would be nice to have all versions in code, so that lint and format tool etc could work on those too.

We could probably use examples/asgilook/versions/01_file.py, examples/asgilook/versions/02_file.py etc

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonBasic understanding of Falcon project structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
The issue proposes moving intermediate tutorial code from RST files to separate Python files (e.g., examples/asgilook/versions/01 file.py, 02 file.py) to enable linting and formatting. The current state only has final versions in the example folder. Work should involve creating the versioned files, updating the RST files to reference them, and ensuring the build process still works. See the issue comment thread for any additional guidance.