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

Datatree docs should mention that assigning to .dataset is allowed #9449

Open
TomNicholas opened this issue Sep 7, 2024 · 3 comments · May be fixed by #9842
Open

Datatree docs should mention that assigning to .dataset is allowed #9449

TomNicholas opened this issue Sep 7, 2024 · 3 comments · May be fixed by #9842
Labels
contrib-good-first-issue topic-DataTree Related to the implementation of a DataTree class topic-documentation

Comments

@TomNicholas
Copy link
Member

What is your issue?

See xarray-contrib/datatree#312, fyi @flamingbear

@TomNicholas TomNicholas added topic-documentation topic-DataTree Related to the implementation of a DataTree class labels Sep 7, 2024
@TomNicholas TomNicholas changed the title Datatree docs should mention that assigned to .ds is allowed Datatree docs should mention that assigning to .ds is allowed Sep 8, 2024
@flamingbear flamingbear changed the title Datatree docs should mention that assigning to .ds is allowed Datatree docs should mention that assigning to ~.ds~ .dataset is allowed Sep 10, 2024
@flamingbear flamingbear changed the title Datatree docs should mention that assigning to ~.ds~ .dataset is allowed Datatree docs should mention that assigning to .ds is allowed Sep 10, 2024
@flamingbear
Copy link
Member

Well, .dataset anyway from the outcome of #9458

@shoyer shoyer changed the title Datatree docs should mention that assigning to .ds is allowed Datatree docs should mention that assigning to .dataset is allowed Sep 13, 2024
@adam2392
Copy link

Hey I've always found Xarray useful, so I wanted to start understanding the internal codebase more. Happy to take this on if no one else is tackling it?

@TomNicholas
Copy link
Member Author

That would be great @adam2392 ! The implementation of the property and setter that needs documenting is here

def dataset(self) -> DatasetView:

The fact you can assign to this property should probably be documented

  1. In the docstring of the property
  2. here https://docs.xarray.dev/en/stable/user-guide/data-structures.html#datatree-contents
  3. and in a new section under here https://docs.xarray.dev/en/stable/user-guide/hierarchical-data.html#tree-contents

@adam2392 adam2392 linked a pull request Nov 29, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contrib-good-first-issue topic-DataTree Related to the implementation of a DataTree class topic-documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants