python / python/mypy

Tweak the mypy badge to include the word "type"

Open
#12,796 2 comments 6 reactions 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

Documentation

Comparing the current mypy logo:

Type checked with mypy

With several others in the community:

Code style: black
Imports: isort

I think that the mypy badge could be improved by reversing the order and adding the word "type" into the badge to make it more clear that type checking is what is involved.

Type checked with mypy

Also, #9919 should also be fixed so that the hosted badge can be properly displayed in areas that secure links are required.

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

Search the repository for the current mypy badge markup shown in the issue, then read issue #9919 for the hosted-badge context. Update the badge wording as requested and verify that the hosted badge can be displayed where secure links are required.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.