Document the HTML/XML report generator

python / mypy

Optional static typing for Python

https://www.mypy-lang.org/

Other

18.18k stars 2.77k forks source link

Document the HTML/XML report generator #912

Open JukkaL opened 8 years ago

JukkaL commented 8 years ago

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.

o11c commented 8 years ago

In readme or what? The website doesn't appear to live in any git repo.

I'm using it in https://github.com/o11c/lr-parsers though I haven't done much there since I started working on mypy.

JukkaL commented 8 years ago

The documentation lives under docs/. Hmm if you can't find it then it's probably not discoverable enough.

o11c commented 8 years ago

I must confess I'm used to ignoring any folder called doc/ or docs/ because it's always obsolete. --help and pydoc3 are usually more useful.

Still would like to see source for the mypy website proper.

JukkaL commented 8 years ago

Yeah, publishing mypy website sources is somewhere on my to-do list but it's a big mess and I might be too embarrassed to publish it without some cleaning up.