Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ruff pydocstyle adoption #5637

Closed
tkknight opened this issue Dec 13, 2023 · 1 comment
Closed

ruff pydocstyle adoption #5637

tkknight opened this issue Dec 13, 2023 · 1 comment
Assignees

Comments

@tkknight
Copy link
Contributor

tkknight commented Dec 13, 2023

📚 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

  1. Comment out a rule to enable it, see the pydocstyle section in .ruff.toml , look for the Temporary comment.
  2. Run ruff. $ ruff lib/iris (you may need to pip install ruff first)
  3. 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.
  4. When ruff runs with no warnings or errors remove the commented out rule completely and create a PR in the usual fashion.
@tkknight
Copy link
Contributor Author

Duplicate, see #5625

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant