Some type annotations for coords.py

[rcomer]

🚀 Pull Request

Description

Added some type hints relevant to the changes in #5955

---

Consult Iris pull request check list

[rcomer]

Rebased. CI is green. Ready for review 😎

[rcomer]

Added some type hints for the method and function I modified, as well as ones required to tidy up PyRight complaints within the collapsed method. The form import numpy.typing as npt is taken from examples in the numpy docs.

[rcomer]

Some screenshots of the built docs:

now redundant as we turned hints off in the docs at #4510

[rcomer]

Made some changes to the type hints following a chat with @bjlittle this morning, and taking some inspiration from @jamesp's stubs.

The rendered docs look better:

now redundant as we turned hints off in the docs at #4510

[bjlittle]

@bjlittle get your finger out...

[bjlittle]

@rcomer Fancy doing a rebase?

[rcomer]

Now rebased.

@bjlittle it's all on you now 😛

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.78%. Comparing base (44257eb) to head (1a63e4c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4294   +/-   ##
=======================================
  Coverage   89.78%   89.78%           
=======================================
  Files          88       88           
  Lines       23060    23064    +4     
  Branches     5031     5031           
=======================================
+ Hits        20704    20708    +4     
  Misses       1624     1624           
  Partials      732      732           

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

[rcomer]

See #5955 for a version of this fix without the type-hinting rabbit hole.

[rcomer]

The bugfix has now been merged in #5955 so I have rebased this to only include the type changes. It seems that mypy is unhappy though and I'm not sure if/when I will be motivated to investigate that.