search

twisted / pydoctor

This is pydoctor, an API documentation generator that works by static analysis.
https://pydoctor.readthedocs.io
Other
184 stars 49 forks source link

epylint #43

Open mwhudson opened 9 years ago

mwhudson commented 9 years ago

I'd like a tool that I can run which will quickly validate as much epytext as possible. In the vein of pyflakes or pep8.py, it doesn't have to catch everything, as long as it can catch a few common things quickly. Thanks to those tools providing real-time feedback in the background of my editor, I pretty much never type NameErrors any more, and I rarely get spacing wrong, but I still make pydoctor syntax errors all the time.

Pretty much everybody's editor has a persistent python interpreter nowadays, so this could be a sidecar process that hangs out for a while and keeps some state around, if necessary, as long as it looks like it's just a command-line tool on the front end.

Imported from Launchpad using lp2gh.

mthuurne commented 4 years ago

A simple implementation for this would be to let pydoctor parse all docstrings (whether it's epytext or RST or something else) and not generate any output. Currently a lot of processing happens on demand, but I was already considering refactoring to have a strict separation between the information gathering phase and the output generation phase.