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

DOC: Add note to docs on DataTree root-group naming conventions #9298

Merged
merged 7 commits into from
Aug 2, 2024

Conversation

kmuehlbauer
Copy link
Contributor

root group name is always "/"

xarray/core/datatree.py Outdated Show resolved Hide resolved
xarray/core/datatree.py Outdated Show resolved Hide resolved
@TomNicholas TomNicholas added topic-documentation topic-DataTree Related to the implementation of a DataTree class labels Jul 31, 2024
Copy link
Contributor

@flamingbear flamingbear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I played with the generated doc strings but couldn't get them to work with the .. note:: pragma But have added what I would suggest and shown some output.

You can apply these suggestions and merge this or I can just pull these changes into the #9033.

xarray/core/datatree.py Outdated Show resolved Hide resolved
xarray/core/datatree.py Outdated Show resolved Hide resolved
xarray/datatree_/docs/source/io.rst Outdated Show resolved Hide resolved
xarray/datatree_/docs/source/io.rst Outdated Show resolved Hide resolved
flamingbear added a commit to flamingbear/xarray that referenced this pull request Jul 31, 2024
kmuehlbauer and others added 5 commits August 1, 2024 07:49
Co-authored-by: Matt Savoie <github@flamingbear.com>
Co-authored-by: Matt Savoie <github@flamingbear.com>
Co-authored-by: Matt Savoie <github@flamingbear.com>
Co-authored-by: Matt Savoie <github@flamingbear.com>
@kmuehlbauer
Copy link
Contributor Author

You can apply these suggestions and merge this or I can just pull these changes into the #9033.

Oh well, I've just applied the proposed changes. But do whatever suits best for your doc integration workflow. You might still pull everything you need from here. I can also squash everything into one commit, if that's easier.

@flamingbear
Copy link
Contributor

@kmuehlbauer I think this is fine to merge or close either way is fine with me. I grabbed the pieces you wrote trying to test it out. ec341ad But that may still take a while to get to main. I'll approve this for you in either case.

Copy link
Contributor

@flamingbear flamingbear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for the update.

@kmuehlbauer
Copy link
Contributor Author

OK, then let's merge it here to closeout #9293.

@kmuehlbauer kmuehlbauer merged commit 0bd69ca into pydata:main Aug 2, 2024
28 checks passed
@kmuehlbauer kmuehlbauer deleted the datatree-root-node-name branch August 2, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic-DataTree Related to the implementation of a DataTree class topic-documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Losing top level name attribute when saving and then reopening using h5netcdf
3 participants