mozilla / mozanalysis

A library for Mozilla experiments analysis
https://mozilla.github.io/mozanalysis/
Mozilla Public License 2.0
10 stars 13 forks source link

Add docstring checks to RUFF #218

Open jaredsnyder opened 6 months ago

jaredsnyder commented 6 months ago

It would be great to activate the pydocstyle docstring "D" rules in Ruff, but Ruff currently doesn't support sphinx formatting for docstrings. There is an open ticket (https://github.com/astral-sh/ruff/issues/6606) and if/when it gets merged we should add docstring checks.

An open issue is whether we want to require docstrings in the tests folder. I think it would be nice but given the sheer number of functions that need docstrings and the questionable utility it might not be worth it.