You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 to pip install ruff first)
Fix any issues. Using the command line option --auto may 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.
The text was updated successfully, but these errors were encountered:
📚 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
$ ruff lib/iris
(you may need topip install ruff
first)--auto
may help but please check what has changed and that it renders in the built docs ok.The text was updated successfully, but these errors were encountered: