Sample code for: How to Write an AGENTS.md File for a Python Project#781
Merged
Conversation
stephengruppetta
approved these changes
Jul 15, 2026
stephengruppetta
left a comment
stephengruppetta
left a comment
Contributor
There was a problem hiding this comment.
@lpozo just a minor comment here
Comment on lines
+29
to
+41
| def create_car(car: dict): | ||
| car["id"] = len(cars) + 1 | ||
| cars.append(car) | ||
| return {"message": "Car created successfully", "car": car} | ||
|
|
||
|
|
||
| @app.delete("/cars/{car_id}") | ||
| def delete_car(car_id: int): | ||
| for i in range(len(cars)): | ||
| if cars[i]["id"] == car_id: | ||
| cars.pop(i) | ||
| return {"message": "Car deleted"} | ||
| return {"error": "Car not found"} |
Contributor
There was a problem hiding this comment.
The original code in the tutorial uses single quotes for the strings in the dicts and for 'id', and this is one of the "flaws" you discuss from the first run. I suggest breaking our convention for proper formatting in the materials and use the original single quotes here, even if CI complains!
The tutorial presents run1_main.py as the agent's flawed first-run output, and one of the flaws it calls out is the use of single-quoted strings. Ruff formatting had normalized them to double quotes, which contradicted the article. Restore the original single quotes and exclude this one file from Ruff, following the existing how-to-indent-in-python/sample_code.py precedent. Addresses @stephengruppetta's review comment on PR #781. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Where to put new files:
my-awesome-articleHow to merge your changes:
Code examples for the How to Write an AGENTS.md File for a Python Project tutorial. Files live in the
agents-md/top-level folder, named after the article slug.Generated from the tutorial markdown with the
post-materialsskill, then verified locally before pushing.Contents:
original_main.py— the starter FastAPI apprun1_main.py— the agent's output without anAGENTS.md(the flawed run)run2_main.py— the agent's output with theAGENTS.mdin placetest_main.py— tests againstrun2_main.py(both pass)cars.json— the sample datasetAGENTS.md— the complete config file built across the tutorial