📝 Update docs to use Typer() more prominently#1418
Merged
tiangolo merged 35 commits intofastapi:masterfrom Nov 25, 2025
Merged
Conversation
svlandeg
commented
Nov 21, 2025
svlandeg
commented
Nov 21, 2025
svlandeg
commented
Nov 21, 2025
Contributor
svlandeg
commented
Nov 21, 2025
svlandeg
commented
Nov 21, 2025
svlandeg
commented
Nov 24, 2025
svlandeg
commented
Nov 24, 2025
Member
Author
svlandeg
left a comment
There was a problem hiding this comment.
Ok, this should be now in a good state.
Searching through the code base, the only places that still refer to typer.run() are
- the "first steps" part of the tutorial
docs_src/arguments/optional/tutorial000.pywhich was created in this PR specifically to gradually build up the complexity in the "Arguments" docs sectiondocs_src/testing/app03which specifically talks about testing code that don't useTyper()
Everything else is now converted to Typer() and all highlighting in the documentation has been updated, including a few fixes of things that weren't exactly right on master (made separate comments about these).
tiangolo
reviewed
Nov 24, 2025
Member
tiangolo
left a comment
There was a problem hiding this comment.
This is looking great! 🚀 🎉
Thanks a lot for going through it all! 🙌
I just reviewed everything, it all looks good. I didn't review the highlighted lines, but I know you did.
I was thinking about the new page name, what do you think?
This was referenced Nov 25, 2025
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
2 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.
In an attempt to be minimal/clear, the docs have mostly been using
typer.run. However for proper applications, we recommend to useTyper()directly, which unlocks much more options. As such, we're updating the docs here. This has the added advantage that it's easier to experiment with given tutorial examples without first having to adjust them to useTyper().I know reviewing this is horrible. I've taken the time to go through every edit carefully (0% vibe coding ;-)). Mostly, this meant updating the tutorial examples and then updating the highlighted lines in the documentation markdown files. There were some special cases, that I'll highlight as review comments.