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

Document the new ignore_axis functionality. #5589

Closed
HGWright opened this issue Nov 17, 2023 · 4 comments · Fixed by #5744
Closed

Document the new ignore_axis functionality. #5589

HGWright opened this issue Nov 17, 2023 · 4 comments · Fixed by #5744
Assignees
Milestone

Comments

@HGWright
Copy link
Contributor

📚 Documentation

#5003 requested and #5551 delivered the ability to manually set ignore_axis for a coordinate and as a result guess_coord_axis will not act on that coordinate. We currently do not have documentation for this change as we didn't feel the need to require it in #5551. This is something we would like to add in the future. The docstrings have been updated but we feel that this deserves a bit more documentation.

@trexfeathers trexfeathers added this to the v3.8 milestone Nov 21, 2023
@trexfeathers
Copy link
Contributor

This is another case for the NetCDF I/O technical paper*. Introducing this paper does NOT mean writing the whole thing - the plan would be to just add the relevant section, and make it clear to readers that the page is not exhaustive and there is more to write in future.

* The tech papers probably shouldn't stay in the Developer's Guide really

@pp-mo
Copy link
Member

pp-mo commented Nov 21, 2023

another case for the NetCDF I/O technical paper

I reckon we've now clocked up (at least) 4 "special detail issues" relating to netcdf, that would really like a place like that to live :


The tech papers probably shouldn't stay in the Developer's Guide really

Totally, I think they should all be combined in the further topics UserGuide area

@trexfeathers
Copy link
Contributor

@ESadek-MO is laying the ground work in #5597, simply because this is the first one to be worked on

@trexfeathers
Copy link
Contributor

@ESadek-MO is laying the ground work in #5597, simply because this is the first one to be worked on

=============================
NetCDF I/O Handling in Iris
=============================
This document provides a basic account of how Iris loads and saves NetCDF files.
.. admonition:: Under Construction
This document is still a work in progress, so might include blank or unfinished sections,
watch this space!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

3 participants