search

econchick / interrogate

Explain yourself! Interrogate a codebase for docstring coverage.
https://interrogate.readthedocs.io
MIT License
574 stars 44 forks source link

[Feature Request] add parameters and return object coverage #53

Open saroad2 opened 4 years ago

saroad2 commented 4 years ago

One thing I think is absent from this tool, as well as from pydocstyle and other documentation validation tools, is the ability to check that all parameters are documented, not just the methods. If this tool would have this ability, I would really like to use it.

s-weigand commented 4 years ago

Didn't test it yet, but do you mean something like darglint?

saroad2 commented 4 years ago

Didn't know darglint before. This is exactly what I've been looking for! Still, I'm thinking it might be a good direction for interrogate as well.

Feel free to close the issue if you think otherwise.