falconry/falcon

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

Open

#2247 opened on Jul 13, 2024

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Python (9,293 stars) (925 forks)batch import
documentationgood first issuemaintenance

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonBasic understanding of Falcon project structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.