search

ConaireD / TolimanWIP

WIP Toliman codes go here before being added to the main TOLIMAN github
Other
0 stars 0 forks source link

Use `pytest-pydocstyle`. #22

Closed Jordan-Dennis closed 1 year ago

Jordan-Dennis commented 1 year ago

Hi all, This will let us automatically test that our docstrings are correctly formatted. I think that this will be useful. Regards Jordan.

ConaireD commented 1 year ago

Sounds good

Jordan-Dennis commented 1 year ago

So it turns out that pytest-pydocstyle is just a wrapper to pydocstyle like pytest-black is a wrapper to black. I think that we keep these separate from the tests.

Jordan-Dennis commented 1 year ago

You can specify the docstring convention that you are using like pydocstyle --convention=numpy. I alo discovered a nice little hack for the number of problems using pydocstyle | wl -l however you must divide by two.