Type check coverage reports need more love

Open
#1,123 5 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
cli, tooling

Research direction

Start at the report-generating code reached by the --html-report and --xml-report flags, then review the report, testing, dependency, XSLT, documentation, and hover-text concerns listed in the issue. Done should mean the addressed concerns have tests and documented behavior, including the cases described here.

Written by the indexing model from the issue text.

Description

bug priority-1-normal

The report generating code (using command-line flags like --html-report dir or --xml-report dir) has some issues.

  • There are no tests
  • No report is generated for files not under the current directory
  • When errors are reported, the top level index.html is not generated
  • There's an undeclared dependency on lxml (#1001)
  • The use of XSLT is dubious (#909)
  • It needs docs (#912)
  • Feature request to add hover text to html reports: #313
Dominant language
Python
Stars
20.6k
Forks
3.3k
Avg merge
1d 18h
Merged PRs (30d)
54

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.

More from python/mypy

All issues in python/mypy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.