Skip to content

ruff pydocstyle adoption #5637

@tkknight

Description

@tkknight

📚 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.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions