✏️ Use Annotated in inline example in docs/en/docs/tutorial/body-multiple-params.md#15591
Merged
Conversation
The full example in the tutorial recommends and uses Annotated, but one line still uses the non-Annotated syntax.
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the FastAPI tutorial snippet for embedded body parameters to use typing.Annotated with Body(embed=True) instead of a default value assignment.
Changes:
- Replaced
item: Item = Body(embed=True)withitem: Annotated[Item, Body(embed=True)]in the documentation snippet.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
📝 Docs previewLast commit 5ffdaae at: https://b585afc3.fastapitiangolo.pages.dev Modified Pages |
tiangolo
changed the title
Annotated in inline example in docs/en/docs/tutorial/body-multiple-params.md
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
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.
The full example in the "Body - Multiple Parameters" tutorial recommends and uses Annotated, but one line still uses the non-Annotated version.
Pull Request
Discussion: This seemed like an obvious issue with a straightforward fix, so I did not start a discussion.
Description
My PR updates the line to use Annotated.
AI Disclaimer
No AI used :)
Checklist