python / python/mypy

Document TypedDict 'in' narrowing

Open
#15,695 6 comments 0 reactions 0 assignees View on GitHub

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

In particular, document the need for @final in order for it to work.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the mypy documentation covering TypedDict and in narrowing. Document that the narrowing requires @final, and consider the work done when the relevant guidance clearly explains this requirement.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.