Better documentation for the HTML report
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Documentation
This is the only thing I can find in the docs about this HTML report, and it's far from complete. I could find these three questions on Stack Overflow, but none of them have satisfying answers (or answers at all).
I understand that mypy is reporting the presence of expressions of type Any in each line. (Is it? Did I get that right?) But what exactly do the colors mean? Why do lines with @overload always get colored red in my reports? Why do lines with isinstance always get colored yellow?
Contributor guide
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.
Research direction
Start with the command-line HTML report documentation linked in the issue, then use the three linked Stack Overflow questions to identify the missing explanations. Document what the report measures, what its colors mean, and why constructs such as @overload and isinstance receive their observed colors; done means users can interpret the report without relying on unanswered external questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100