← Back to issue list

docs: Running Flask, Django and FastAPI should be in a code block

View original Github issue

Metadata

Project
rockcraft
Number
#1147
Type
pull request
State
merged
Author
zlplzp123wyt
Labels
Created
Updated
Closed

Current evaluation

Merged after resolving a documentation conflict and verifying contributor CLA status. Changes convert inline Flask, Django, and FastAPI run commands to code blocks, improving readability and consistency. Approved by four reviewers with all CI checks passing.

Suggested action:

No scores available.

Issue body

Fixes #1145 This PR changes inline instructions to code blocks in the Flask, Django, and FastAPI tutorials. Changes: - flask.rst: Changed inline `flask run -p 8000` to code block - django.rst: Changed inline `python manage.py runserver` to code block - fastapi.rst: Changed inline `fastapi dev app.py --port 8000` to code block This improves readability and consistency with other documentation.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged after resolving a documentation conflict and verifying contributor CLA status. Changes convert inline Flask, Django, and FastAPI run commands to code blocks, improving readability and consistency. Approved by four reviewers with all CI checks passing.
qwen3.6-35b-a3b-mtp-q6 Merged after resolving a conflict and passing CI checks. Converts inline run commands for Flask, Django, and FastAPI tutorials into code blocks to improve documentation readability and consistency.
qwen3.6-35b-a3b-mtp-q6
Staleness: 25
Complexity: 10
Confidence: 90
keep open Converts inline commands to code blocks in Flask, Django, and FastAPI tutorials for better readability. Approved with green CI checks, but currently awaiting merge conflict resolution and final maintainer approval.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1145 docs: Running Flask, Django and FastAPI should be in a code block rockcraft closed Fixed and closed after another contributor implemented the requested code block formatting for the Flask, Django, and FastAPI tutorials.
85%
#1191 docs: put run-the-app instructions in their own code block rockcraft merged 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.
77%
#2343 docs: fix technical issues in go and fastapi tutorials charmcraft merged Merged documentation fixes for Go and FastAPI tutorials. Resolved rendering issues, removed outdated Flask references, and corrected config blocks. Approved by three reviewers and merged after CI checks, with 18 additions and 14 deletions.
70%