Add py.typed marker
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
Research direction
Start by locating the packaged markdown2 module and the project’s packaging configuration, then check how package data is included in distributions. Done means a py.typed marker is shipped with markdown2 and mypy and Pyright no longer report the missing type-information warnings.
Written by the indexing model from the issue text.
Description
When importing markdown2, I’m seeing the following linter warnings:
- mypy: Skipping analyzing "markdown2": module is installed, but missing library stubs or py.typed marker.
- Pyright: Stub file not found for "markdown2"
I noticed that typing support was introduced in PR #581 — thanks for that! I was wondering if there might be one additional step needed to make this fully recognized by type checkers.
From what I understand, adding a py.typed file to the package can help tools like mypy and Pyright detect that the package includes type information (as mentioned in #456 and #562). For reference, this might be helpful:
https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/
If this sounds reasonable and you would like to have support, I’d be happy to help.
- Dominant language
- Python
- Stars
- 2.8k
- Forks
- 459
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
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.
More from trentm/python-markdown2
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
trentm/python-markdown2#726 ·
-
Bug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
trentm/python-markdown2#707 ·
-
Bug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
trentm/python-markdown2#688 · 4 comments ·
-
Bug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
trentm/python-markdown2#679 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
trentm/python-markdown2#635 · 2 comments ·
All issues in trentm/python-markdown2
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
stephrobert/dsoxlab#238 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
sublimehq/package_control#1780 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nwg-piotr/nwg-displays#145 ·