xpublish-community / xpublish

Publish Xarray Datasets via a REST API.
https://xpublish.readthedocs.io
Apache License 2.0
168 stars 23 forks source link

Clean up Docstrings #186

Closed abkfenris closed 11 months ago

abkfenris commented 1 year ago

There are a handful of different docstring formats being used, so it would be nice to standardize them, maybe using the napoleon Google example format.

It might be worth taking a look at pydocstyle or ruff to help standardize formatting. Either one should be added to our pre-commit hooks. Ruff might be a nice choice as it can take over for some of our other hooks, and other projects in the Pydata ecosystem are moving to it.

I've just stumbled upon this change, because I wanted to know how you use sphinx-autodoc-typehints in a napoleon project.

Originally posted by @thisch in https://github.com/xpublish-community/xpublish/pull/167#pullrequestreview-1386288191