-
Notifications
You must be signed in to change notification settings - Fork 300
Closed
Labels
Description
📚 Documentation
GOAL: Comply with the ruff pydocstyle rules.
Related to #4721.
Ruff is currently configured to check the codebase, however a long list of ignores have been added to allow clean runs that reports no warnings or errors - for now.
We need to go through each rule, remove the ignore and then run ruff to check what is needed to be fixed. If ruff runs with not warnings/errors reported then bank the change.
Summary of Steps
- Comment out a rule to enable it, see the pydocstyle section in .ruff.toml , look for the Temporary comment.
- Run ruff.
$ ruff lib/iris(you may need topip install rufffirst) - Fix any issues. Using the command line option
--automay help but please check what has changed and that it renders in the built docs ok. - When ruff runs with no warnings or errors remove the commented out rule completely and create a PR in the usual fashion.