Clarify laziness status of all iris functions

[corinnebosley]

Make clear in all docstrings which functions are lazy and which are not.

Currently only some functions have this description (presumably those which have been updated to be lazy recently). It would be much more useful to the user if they could immediately see from every single docstring whether the function is lazy or not.

[corinnebosley]

• #3293

[trexfeathers]

@ESadek-MO and I have agreed to submit as much documentation as can be written before v3.4. Seems sensible to have a PR up on Monday 14/11.

We can keep this issue open if there are more modules still to cover.

[ESadek-MO]

• [x] analysis module: init.py, calculus.py, cartography.py, maths.py, trajectory.py

• [x] io module: init.py

• [ ] cube.py

• [x] iterate.py

• [x] palette.py

• [ ] aux_factory.py

• [ ] coords.py

• [ ] common module: mostly irrelevant, perhaps a couple funcs

• [ ] util.py

• [ ] plot.py

• [ ] quickplot.py

• [ ] coord_systems.py

• [ ] coord_categorisation.py

[rcomer]

Is this now complete?

[ESadek-MO]

Yep, now complete, although there might have to be minor changes in the future if and when issues arise.