xarray-contrib / datatree

WIP implementation of a tree-like hierarchical data structure for xarray.
https://xarray-datatree.readthedocs.io
Apache License 2.0
161 stars 43 forks source link

Moves Tree Contents so that simpsons data tree in example is defined. #301

Closed flamingbear closed 5 months ago

flamingbear commented 5 months ago

This is a clone of #300 because I nuked my fork without thinking.

Since I'm reading the docs and don't know sphinx very well, I saw a problem with the is_hollow description and fixed it.

It may make more sense to have Tree Contents: Hollow Trees above Manipulating Trees: Subsetting Tree Nodes, but the simpsons DataTree is undefined. Rather than create a new tree for this example I just moved it.

In addition to moving it I changed the description from a python method to the py:class so that the rendering didn't include the incorrect parens.

The updated docs after rebuilding show the tree is not hollow rather than NameError: name 'simpsons' is not defined as it did before

New image generated:

Screenshot 2024-01-18 at 1 50 51 PM

Also increased clarity of the dt.match() operation by printing the result.

Screenshot 2024-01-18 at 1 49 27 PM

And fixed a typo. wo => twoj

TomNicholas commented 5 months ago

Thanks @flamingbear. FYI the reason I added the content about "hollow trees" was in preparation for #271.