{{ message }}
Improve TypedDict documentation#770
Merged
Merged
Conversation
JelleZijlstra
approved these changes
Jun 25, 2026
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.
TypedDicton Python 3.15 because...typing_extensionsincludes experimental support for PEP 764 (inlineTypedDicts).This PR improves the documentation for
TypedDicts. To test the PR, I built the docs locally, which exposed:CONTRIBUTING.mdon how to do that.mainwith nitpicky mode, because the signature we gave fordataclass_transformin the docs was invalid (you can't do multiline definitions like that with Sphinx). This PR therefore also fixes those issues, and adds a CI job to build the docs with nitpicky mode, to prevent issues like that from reoccurring.