ruff compliance for D405 and D407

[tkknight]

🚀 Pull Request

Description

PR solely for fixing:

• D405: Section name should be properly capitalized
• D407: Missing dashed underline after section

Whilst fixing the docstrings for D407 I noticed it would use two different styles of headings in functions so I fixed all the headings in all files touched, so the PR is a little bigger than planned but the files touched have not grown.

Continues work of #5625.

---

Consult Iris pull request check list

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (41f1107) 89.69% compared to head (92a5cca) 89.69%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5666   +/-   ##
=======================================
  Coverage   89.69%   89.69%           
=======================================
  Files          90       90           
  Lines       22807    22807           
  Branches     5441     5441           
=======================================
  Hits        20456    20456           
  Misses       1618     1618           
  Partials      733      733           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tkknight]

Ready for review.

[bjlittle]

@tkknight Wow. That was hard work for me ... can't imagine what it must have been like on your side 😱

Amazing effort to tidy this up. Just a couple of minor comments to service ... we can hangout and talk it through 👍

[pp-mo]

OK lost of small suggestions + comments.
Got as far down as the end of the lib/iris/analysis/stats.py listing.

I definitely went about this the wrong way.

I will finish the job with remaining suggestions on a PR-to-PR branch

too much overlap with existing discussions + agreed approach

[pp-mo]

General comment : as discussed offline with @bjlittle
My escalating suggestions are getting in the way.
@bjlittle can bank what is here, and I can maybe propose further improvements later.

Please ignore all the noise, I can't find a way to quickly remove all the multiple comments I made 😞

[bjlittle]

@pp-mo Thanks for wading in, but in this case it might have been better touching base with @tkknight (or myself) beforehand.

You weren't to know that @tkknight and I agreed on a strategy over several offline discussion on how to proceed with the ruff adoption for iris, which is happening over the course of many pull-requests.

If you're a gun for hire, then let us know. You're more than welcome to join us help chip away at the mountain of outstanding work to do. Apologies if you lost time and effort on this.