Enable docstring linter in ruff - Githubissues

gammasim / simtools

Tools and applications for the Simulation System of the CTA Observatory.

https://gammasim.github.io/simtools

BSD 3-Clause "New" or "Revised" License

9 stars 1 forks source link

Enable docstring linter in ruff #944

Closed GernotMaier closed 2 weeks ago

GernotMaier commented 1 month ago

The docstring linter in ruff is currently switched off in pyproject.toml (lint.extend-select does not select D).

We should have some minimal linting of the docstrings, especially (all options are listed here):

undocumented public modules, classes, functions
undocumented-param
empty-docstring

Switching all on will require a lot of changes.

Notes:

requires to set lint.pydocstyle.convention = "numpy" in pyproject.toml
alternative would be to enable numpy doc validation in sphinx or precommit (#886)