falconry/falcon

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

Open

#2,247 opened on 2024年7月13日

GitHub で見る
 (8 comments) (0 reactions) (0 assignees)Python (9,293 stars) (925 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.