Figure out if we can use tool to verify docstring format

guarin commented 1 year ago

Requirements

Follows the google python docstring format
It must be possible to ignore formatting on a per function basis

Tasks

[ ] Figure out if such a tool exists
[ ] Add it to PIP and document how to use it. Best is to add a new command to the makefile

ishaanagw commented 1 week ago

Hey @guarin, do you think we can use this - https://pypi.org/project/pydocstringformatter/#what-it-does

guarin commented 1 week ago

Hi, this looks interesting! There also seem to be a bunch of alternatives:

ruff: https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
docformatter: https://github.com/PyCQA/docformatter

Maybe there are also others. My favorite would be ruff because we anyways want to switch to it (https://github.com/lightly-ai/lightly/issues/1564) as it is very fast and we made good experiences with it. Having a single linter would be perfect. That said, I haven't tried it for linting docstrings and am not sure how well it works on our codebase. Would be interesting to try it out.

lightly-ai / lightly

Figure out if we can use tool to verify docstring format #1217

Requirements

Tasks