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 (925 fork)batch import
documentationgood first issuemaintenance

仓库指标

Star
 (9,293 star)
PR 合并指标
 (平均合并 2天 7小时) (30 天内合并 9 个 PR)

描述

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

贡献者指南

研究方向
检查当前的 'examples/asgilook/' 文件夹和 RST 教程文件。提出版本化文件的命名方案（例如 '01 file.py'、'02 file.py'），并将 RST 文件中的中间代码移到这些新文件中。更新 RST 文件以包含来自新文件的代码，而不是内联代码片段。确保所有版本化文件都可以应用 lint 和格式化工具。
技术栈
python
领域
documentation
议题类型
重构
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80