search

twisted / pydoctor

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

doc(FAQ): How to lint? #792

Open buhtz opened 6 months ago

buhtz commented 6 months ago

I am a bit confused about all the different documentation styles. Beside "google" and "epydoc", etc there is also PEP257.

I wonder if you can recommend a doc-style linter and if it matters which one of the pydoctor-supported docu formats I am using. e.g. I decided to use "google" style.

tristanlatr commented 6 months ago

The state of python docstrings standard is pretty bad: no one agrees on a standard. I believe pydoctor should have a lint mode integrated to the CLI. When activated, it won't produce any HTML, only parse all docstrings and generate docstrings stans to warn on link not founds errors and other parsing errors.