Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify laziness status of all iris functions #3292

Closed
corinnebosley opened this issue Mar 6, 2019 · 5 comments
Closed

Clarify laziness status of all iris functions #3292

corinnebosley opened this issue Mar 6, 2019 · 5 comments
Assignees
Labels
Good First Issue A good issue to take on if you're just getting started with Iris development Type: Documentation
Projects

Comments

@corinnebosley
Copy link
Member

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
Copy link
Member Author

@bjlittle bjlittle added this to the v2.3.0 milestone Jun 5, 2019
@bjlittle bjlittle added this to To do in Iris v2.3.0 Jun 9, 2019
@bjlittle bjlittle added this to Backlog in Iris v3.1.0 via automation Nov 13, 2019
@bjlittle bjlittle removed this from To do in Iris v2.3.0 Nov 13, 2019
@bjlittle bjlittle modified the milestones: v2.3.0, v3.1.0 Nov 13, 2019
@trexfeathers trexfeathers added the Good First Issue A good issue to take on if you're just getting started with Iris development label Sep 25, 2020
@bjlittle bjlittle removed this from Backlog in Iris v3.1.0 Aug 4, 2021
@bjlittle bjlittle added this to Backlog in Iris v3.2.0 via automation Aug 4, 2021
@bjlittle bjlittle modified the milestones: v3.1.0, v3.2.0 Aug 4, 2021
@jamesp jamesp modified the milestones: v3.2.0, v3.3.0 Oct 28, 2021
@rcomer rcomer mentioned this issue Apr 28, 2022
91 tasks
@trexfeathers
Copy link
Contributor

@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
Copy link
Contributor

ESadek-MO commented Nov 16, 2022

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

  • io module: init.py

  • cube.py

  • iterate.py

  • 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
Copy link
Member

rcomer commented May 4, 2023

Is this now complete?

@ESadek-MO
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue A good issue to take on if you're just getting started with Iris development Type: Documentation
Projects
No open projects
Status: Done
Status: Done
Development

No branches or pull requests

7 participants