falconry/falcon

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

Open

#2,247 opened on Jul 13, 2024

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

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (Avg merge 2d 7h) (9 merged PRs in 30d)

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

Research direction
Examine the current 'examples/asgilook/' folder and the RST tutorial files. Propose a naming scheme for versioned files (e.g., '01 file.py', '02 file.py') and move the intermediate code from the RST files into these new files. Update the RST files to include the code from the new files instead of inline snippets. Ensure linting and formatting tools can be applied to all versioned files.
Tech stack
python
Domain
documentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80