-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Extending the glossary #7732
Extending the glossary #7732
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is an important addition, the different words and their meaning are always confusing for beginners.
Maybe we could add some very simple examples to demonstrate the effects (1D or 2D arrays).
In general I think you could find better words for "combine", basically every definition uses it.
Actually on top of examples maybe some simple text depictions could be useful? But just throwing ideas around Edit: that's actually not what aligning does, haha. But you get the idea. |
@headtr1ck I have done the changes required, please review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking better and better. I still have several remarks.
Also, the indentation of the compiled docpage looks wrong (see https://xray--7732.org.readthedocs.build/en/7732/user-guide/terminology.html)
After a code block the following text is no longer indented. I have no idea how this exactly works though...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, but none of the new definitions are visible in the rendered docs page. I think this is just an indentation problem.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR! Some things left to clarify.
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Any reason why you removed the examples? |
I was unable to build the examples while doing |
you're ready to see the final result, you tell xarray, "Okay, go ahead and do those calculations now!" | ||
That's when xarray starts working through the steps you planned and gives you the answer you wanted.This | ||
lazy approach helps save time and memory because xarray only does the work when you actually need the | ||
results. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lazy evaluation is provided alternately by dask or by hidden xarray internals, depending on whether dask is installed. I'm wondering whether it's worth mentioning that here or not. @headtr1ck what do you think? I've added it to #7991 so we could link to that page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can leave this clarification for later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work on this!
General comment 1: The definitions are clearest when they start with a single short sentence succinctly describing the term. Then afterwards you can write a paragraph explaining the context or why that's useful. Look at the entries for DataArray etc. to see what I mean.
General comment 2: We could be adding links to other relevant sections of the documentation. For example the entry on indexing should link to the docs page on indexing.
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
Co-authored-by: Tom Nicholas <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @harshitha1201 ! This is a great addition!
Thanks @harshitha1201 |
Added align, broadcast, merge, concatenate and combine to terminology.
-> Closes #3355