Document `Required[]` type in `TypedDict`
Open
Nobody has claimed this yet.
documentation
topic-typed-dict
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
After PEP 655 support is merged (https://github.com/python/mypy/pull/10370) we need to document how Required and NotRequired work.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing PEP 655 and the merged PEP 655 support pull request linked in the issue, then locate the existing TypedDict documentation. Document how Required and NotRequired work, including their use with TypedDict, and confirm the resulting explanation matches the supported behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100