docs: Running Flask, Django and FastAPI should be in a code block
Metadata
Current evaluation
Fixed the Flask, Django and FastAPI tutorials in PR #1191 (commit 32291e2a), giving app-run instructions dedicated code blocks.
Resolution: closed resolved
Reason: The documentation change was merged as canonical/rockcraft#1191 in commit 32291e2a, moving the run instructions into dedicated code blocks for all three tutorials.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Check existing issues
- [x] I've verified that this request isn't described by any existing issues.
### Request
This concerns the Flask, Django and FastAPI tutorials.
After the app is created, there are in-line instructions on how to run the app. This does not match the rest of the instructions and can lead to users potenitally missing it.
These instructions should have their own code block and the text above it should be updated accordingly.
### Document location
https://documentation.ubuntu.com/rockcraft/latest/tutorial/flask/#tutorial-build-a-rock-for-a-flask-app
https://documentation.ubuntu.com/rockcraft/latest/tutorial/django/#tutorial-build-a-rock-for-a-django-app
https://documentation.ubuntu.com/rockcraft/latest/tutorial/fastapi/#tutorial-build-a-rock-for-a-fastapi-app
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Fixed the Flask, Django and FastAPI tutorials in PR #1191 (commit 32291e2a), giving app-run instructions dedicated code blocks. | |
| stealth/space-bunny-alpha | — | closed resolved | Fixed by PR #1191 (commit 32291e2a), which placed Flask, Django, and FastAPI run instructions in dedicated code blocks and updated the surrounding text. | |
| stealth/space-bunny-alpha | — | closed resolved | Documentation was fixed in merged PR #1147 (commit ea260218), adding dedicated Bash code blocks for Flask, Django, and FastAPI run commands. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs formatting fixed by merged PR #1147 (commit ea260218), which moved the inline Flask, Django and FastAPI run instructions into dedicated code blocks in the tutorials. | |
| stealth/space-bunny-alpha | — | closed resolved | Documentation formatting was fixed in commit 32291e2a via PR #1191, moving the Flask, Django, and FastAPI run instructions into dedicated code blocks. | |
| qwen/qwen3.6-35b-a3b | — | — | Fixed and closed after another contributor implemented the requested code block formatting for the Flask, Django, and FastAPI tutorials. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation formatting request fixed. Inline run instructions for Flask, Django, and FastAPI tutorials were moved into code blocks. The issue closed after another contributor implemented the changes. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation formatting was updated to place Flask, Django, and FastAPI run instructions in code blocks. The request was resolved and the issue closed after the assigned contributor applied the changes. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed and handed off to contributor @zlplzp123wyt. The documentation fix to wrap Flask, Django, and FastAPI run instructions in code blocks is being implemented separately. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/rockcraft#1191
(confidence 99%)
Commit 32291e2a is recorded as the resolving documentation change for all three tutorials.
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. | |
| #1191 docs: put run-the-app instructions in their own code block | rockcraft | merged | Merged PR #1191 (32291e2a), moving Flask, Django, and FastAPI run commands into dedicated Bash code blocks and closing #1145. | |
| #2287 docs: align FastAPI tutorial structure with Django tutorial | charmcraft | merged | Merged PR #2287 into hotfix/3.5, aligning the FastAPI tutorial with Django, adding development-cycle sections, correcting “Deplyoing,” and standardizing “Hello, world!” |