Skip to content
This repository has been archived by the owner on Oct 24, 2024. It is now read-only.

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

Merged
merged 4 commits into from
Jan 19, 2024
Merged

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

merged 4 commits into from
Jan 19, 2024

Conversation

flamingbear
Copy link
Contributor

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
Copy link
Member

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

@TomNicholas TomNicholas enabled auto-merge (squash) January 19, 2024 22:49
@TomNicholas TomNicholas merged commit 03b0a8c into xarray-contrib:main Jan 19, 2024
14 checks passed
@flamingbear flamingbear deleted the refix-doc-updates branch January 22, 2024 17:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants