📝 Improve tutorials with clearer comments and docstrings #14040
Conversation
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
Shaptain
commented
Sep 4, 2025
- Added docstring to explain route purpose
- Clarified items store with inline comment
- Improved readability without changing behavior
…prove tutorial004.py withdocstrings for the route and exception handler
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
📝 Docs preview for commit eee7e41 at: https://ae7f8ef7.fastapitiangolo.pages.dev |
svlandeg
reviewed
Sep 8, 2025
There was a problem hiding this comment.
Thanks for your interest in contributing to FastAPI!
Generally, we prefer a PR to deal with one atomic feature/improvement. In this PR, I'm seeing many different edits and I'm not quite sure what they're all for. The linting step on the CI is failling and there seems to be some leftover comments from resolving a merge conflict.
To be able to merge this, the CI will need to go green and edits that are unrelated to the main goal of the PR should be removed. I'll put this in draft while the CI is red - feel free to mark as "ready for review" once the CI is green again and the diff looks good.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.