ruff: incremental adoption about iris HOT 4 OPEN

numpydoc adoption tick list #4721 will address the pydocstyle (D) section in

from iris.

Now #5636 is merged there is now a list of rules that are in the ignore section explicitly can now be addressed one by one in separate PR's.

Rules look here here https://docs.astral.sh/ruff/rules/#pydocstyle-d

• "D100", # Missing docstring in public module (@tkknight #5678)
• "D101", # Missing docstring in public class : ~1313 ruff errors.
• "D102", # Missing docstring in public method : ~7429 ruff errors.
• "D103", # Missing docstring in public function : ~179 ruff errors.
• "D104", # Missing docstring in public package (@tkknight #5677)
• "D106", # : Missing docstring in public nested class (@tkknight #5676)
• "D200", # One-line docstring should fit on one line (@tkknight #5675)
• "D202", # No blank lines allowed after function docstring (@tkknight #5674)
• "D205", # 1 blank line required between summary line and description (@tkknight #5681)
• "D208", # Docstring is over-indented (@tkknight #5656)
• "D209", # Multi-line docstring closing quotes should be on a separate line (@tkknight #5663)
• "D211", # No blank lines allowed before class docstring (@tkknight #5661)
• "D214", # Section is over-indented (@tkknight #5654)
• "D300", # triple double quotes """ / Use triple single quotes '''` (@tkknight #5661)
• "D301", # Use r""" if any backslashes in a docstring (@tkknight #5646)
• "D400", # First line should end with a period (@tkknight #5647)
• "D401", # First line of docstring should be in imperative mood: ... (@tkknight #5687)
• "D403", # First word of the first line should be capitalized (@tkknight #5661)
• "D404", # First word of the docstring should not be "This" (@tkknight #5671)
• "D405", # Section name should be properly capitalized (@tkknight #5666)
• "D406", # Section name should end with a newline (@tkknight #5670)
• "D407", # Missing dashed underline after section (@tkknight #pull/5666)
• "D409", # Section underline should match the length of its name (@tkknight #5662)
• "D410", # Missing blank line after section (@tkknight #5662)
• "D411", # Missing blank line before section (@tkknight #5657)
• "D412", # No blank lines allowed between a section header and its content (@tkknight #5660)
• "D417", # Missing argument descriptions in the docstring (@tkknight #5677)

from iris.

We need to agree on a general way forward here.

See #5612

from iris.

See also #5780 DOCS: Adopt the numpydoc validation rules.

from iris.