Closed alex-l-kong closed 11 months ago
Is your feature request related to a problem? Please describe.
The docstrings in toffy are inconsistently formatted. It would be nice to include a pre-commit hook that verifies formatting.
toffy
Describe the solution you'd like
This article lists a few that we could consider: https://towardsdatascience.com/automate-your-python-code-documentation-with-pre-commit-hooks-35c7191949a4. pydocstyle looks nice.
pydocstyle
@alex-l-kong ruff has some docstring styling. it's implemented in angelolab/maldi-tools, and it uses pydocstyle as a selectable plugin.
ruff
Is your feature request related to a problem? Please describe.
The docstrings in
toffy
are inconsistently formatted. It would be nice to include a pre-commit hook that verifies formatting.Describe the solution you'd like
This article lists a few that we could consider: https://towardsdatascience.com/automate-your-python-code-documentation-with-pre-commit-hooks-35c7191949a4.
pydocstyle
looks nice.