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.