search

angelolab / toffy

Scripts for interacting with and generating data from the commercial MIBIScope
MIT License
10 stars 3 forks source link

Add a pre-commit hook for docstrings #345

Closed alex-l-kong closed 11 months ago

alex-l-kong commented 1 year 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.

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.

srivarra commented 1 year ago

@alex-l-kong ruff has some docstring styling. it's implemented in angelolab/maldi-tools, and it uses pydocstyle as a selectable plugin.