iris.plot arguments

[rcomer]

📚 Documentation

Example: in the contour description we have the keyword "coords: list of Coord objects or". Then "coordinate names" appears on the next line, outside the shading. This doesn't look right and I've spotted several other examples just in that module 🙁

Possibly this will come out in the wash of #3840?

Edit: #1942 changed many of the docstrings in iris.plot, so it's possible that the problem is largely limited to this module.

[trexfeathers]

I certainly wouldn't have expected the docstring format for this to have successfully rendered in RTD.

With examples like this it's not often that we bother scouring the whole codebase and fixing everything at once, instead preferring to incrementally fix lines that we're touching while doing other work. Unfortunately that would make it very difficult to tell when this issue could be closed. Maybe an exhaustive check-and-fix of this problem is therefore necessary; it would probably make a good first issue?

[trexfeathers]

Possibly this will come out in the wash of #3840?

I would definitely expect so, but that's an even bigger piece to finish.

[rcomer]

Hmmm, now I've looked closer, this particular example was also wrong in the legacy docs so not a readthedocs issue. Looks like these docstrings were all re-jigged at #1942, so perhaps it is just this module? 🤔

[rcomer]

@trexfeathers thanks for your thoughts. I have reduced the scope of this issue to the iris.plot module, which should make it a lot easier to close 🙂