python / python/mypy

Test and document `MYPY_FORCE_COLOR`/`FORCE_COLOR`

Open
#13,815 14 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation feature topic-configuration topic-tests
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

MYPY_FORCE_COLOR is an environment variable that can be used to, well, force color in mypy's output. It's a useful configuration setting that's used by several projects.

The environment variable is currently undocumented and untested. If #13814 is merged, people will also be able to use FORCE_COLOR to specify the same thing, and that will also be undocumented and untested.

It would be good to add docs and tests for these environment variables.

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

No files or tests are named in the issue. Search the repository for MYPY_FORCE_COLOR and FORCE_COLOR, then inspect the existing output-color tests and configuration documentation. Done means both environment variables are covered by tests and documented with their behavior and precedence.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.