search

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 until after simpsons DataTree is defined. #300

Closed flamingbear closed 5 months ago

flamingbear commented 5 months ago

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

Screenshot 2024-01-17 at 3 00 58 PM

Also tossed in a visualization of the subsetting dt.match(*.B) result and a typo wo -> two

flamingbear commented 5 months ago

Maybe I should have batched these up. Because I see another quick fix.

flamingbear commented 5 months ago

Since this isn't merged, I'm going to toss in the two other quick fixes I saw.

flamingbear commented 5 months ago

Yeah, that was me being not particularly bright and mucking with merging my datatree and xarray repos. I will update this again with a fresh PR. Sorry.