python / python/mypy

(📚) Document that `typing.type_check_only` isn't supported

Open
#12,396 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

I wonder if there are other features that mypy doesn't support(ParamSpec/Concatenate?), perhaps a section of the docs for unsupported features should be added?

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 reviewing the existing mypy documentation for typing features and locate the most appropriate section for unsupported features. Document that typing.type_check_only is not supported, then decide whether the mentioned ParamSpec and Concatenate questions belong in the same section; done means the limitation is clearly recorded and the documentation builds or checks successfully.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.