Document the HTML/XML report generator

Open
#912 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

No file, test, or entry point is named. Locate the HTML/XML report generator in the mypy codebase, read its current implementation and documentation conventions, and document how to use it; done means users can discover and try the generator.

Written by the indexing model from the issue text.

Description

documentation priority-1-normal

I think that it's currently totally undcomented. Even though it's not very polished it could be useful, and we won't get bug reports if people don't even try it.

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.