-
Notifications
You must be signed in to change notification settings - Fork 297
DOC: clarify save_pairs_from_cube docstring #5783
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5783 +/- ##
=======================================
Coverage 89.74% 89.74%
=======================================
Files 92 92
Lines 22941 22942 +1
Branches 5463 5464 +1
=======================================
+ Hits 20589 20590 +1
Misses 1620 1620
Partials 732 732 ☔ View full report in Codecov by Sentry. |
I chased this down. It used to have a role in "rules logging", which we got rid of a long time ago. I'm also not sure how we go about tidying this. |
|
Yes I could and I think that would be cleaner - thanks! I got here by looking at the example in the user guide which I think could also use |
Yup, that's my preferred solution. We can always bugfix it back in if someone's calls are still expecting more arguments. |
Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK it's backwards-breaking, but we've discussed that enough I think.
Let's run with it + see what happens!
Thanks @pp-mo! |
* upstream/main: DOC: clarify save_pairs_from_cube docstring (SciTools#5783)
…th_numpydoc * upstream/main: (39 commits) Bump scitools/workflows from 2024.03.3 to 2024.04.0 (SciTools#5907) [pre-commit.ci] pre-commit autoupdate (SciTools#5906) Updated environment lockfiles (SciTools#5904) Ignore flaticon.com in linkchecks. (SciTools#5905) Implement lazy area weights (SciTools#5658) Add option to specify chunks in `iris.util.broadcast_to_shape` (SciTools#5620) Unpin sphinx (SciTools#5901) DOC: clarify save_pairs_from_cube docstring (SciTools#5783) Restore latest Whats New files. Whats new updates for `v3.9.0rc0` (SciTools#5899) nep29: drop py39 and support py312 (SciTools#5894) Support NetCDF v3 files in chunking control code. (SciTools#5897) Avoid computing lazy scalar coordinates when printing a Cube (v2) (SciTools#5896) Force pytest colour output on GitHub Actions (SciTools#5895) Make typing 3.9 compatible. Improve typing readability. Updated environment lockfiles (SciTools#5892) [pre-commit.ci] pre-commit autoupdate What's New entry for SciTools#5740 . Iris to GeoVista conversion (SciTools#5740) ...
🚀 Pull Request
Description
I'm glad this function exists publicly as it was the solution to my problem today but I found the docstring confusing: because it said it could convert an iterable of cubes, I tried passing a cubelist, which failed because cubelists have no
shape
attribute.I also note that the
target
parameter does not appear to be used for anything, but I don't think I want to pull on that thread right now...Consult Iris pull request check list