docs: put run-the-app instructions in their own code block
Metadata
Current evaluation
Merged PR #1191 (32291e2a), moving Flask, Django, and FastAPI run commands into dedicated Bash code blocks and closing #1145.
Resolution: closed resolved
Reason: PR canonical/rockcraft#1191 was merged as commit 32291e2a. It updated all three tutorials so their run commands appear in dedicated Bash code blocks.
Evaluated by: mr-cal-bot
No scores available.
Issue body
## What changed
The "run the app" instructions on the Flask, Django, and FastAPI tutorials were inlined in the prose as RST inline code. Every other command on the same pages uses a proper code block (either `literalinclude` or `.. code-block:: bash`), so the inlined versions read as inconsistent and, per [#1145](https://github.com/canonical/rockcraft/issues/1145), users were scrolling past them.
Each of the three tutorials now promotes the inlined command into its own `.. code-block:: bash` block, and the lead-in sentence has been tightened so it reads naturally before the block. The change shape is identical across all three files.
## Files touched
- `docs/tutorial/flask.rst`, line 52 area: `flask run -p 8000`.
- `docs/tutorial/django.rst`, line 53-54 area: `python manage.py runserver`. The two sentences ("Enter the directory. Then run the Django app...") were fused into one so the block flows from it cleanly.
- `docs/tutorial/fastapi.rst`, line 53-54 area: `fastapi dev app.py --port 8000`.
## Not touched
- The `docs/tutorial/code/<framework>/task.yaml` files keep the existing background `&` form plus the `retry` + `kill` logic, since those are what the spread tests actually use. The user-facing code block intentionally shows the foreground command without `&`, matching what a learner would type.
## Resolves
Closes #1145.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1191 (32291e2a), moving Flask, Django, and FastAPI run commands into dedicated Bash code blocks and closing #1145. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as canonical/rockcraft#1191 (32291e2a), moving Flask, Django and FastAPI run commands into dedicated Bash code blocks. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update moving run-the-app commands for Flask, Django, and FastAPI tutorials to dedicated bash code blocks for consistency. Resolves #1145. Spread tests remain unchanged as they already verify execution. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update moving Flask, Django, and FastAPI run commands into standalone bash code blocks for consistency. Resolves #1145. Spread tests remain unchanged as they already verify app execution. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/rockcraft#1145
(confidence 100%)
This documentation-formatting issue was explicitly resolved by PR #1191.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1147 docs: Running Flask, Django and FastAPI should be in a code block | rockcraft | merged | Merged PR #1147 (commit ea260218) moved Flask, Django, and FastAPI run commands into code blocks, resolving #1145; follow-up #1191 also recorded the fix in 32291e2a. | |
| #1145 docs: Running Flask, Django and FastAPI should be in a code block | rockcraft | closed | Fixed the Flask, Django and FastAPI tutorials in PR #1191 (commit 32291e2a), giving app-run instructions dedicated code blocks. |