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

Docs page on internal design #7991

Merged
merged 23 commits into from
Sep 8, 2023
Merged

Conversation

TomNicholas
Copy link
Member

@TomNicholas TomNicholas commented Jul 17, 2023

Adds a new page to the xarray internals documentation giving an overview of the internal design of xarray.

This should be helpful for xarray contributors and for developers of extensions because nowhere in the docs does it really explain how DataArray and Dataset are constructed from Variable.

  • Closes #xxxx
  • Tests added
  • User visible changes (including notable bug fixes) are documented in whats-new.rst
  • New functions/methods are listed in api.rst

@@ -1,31 +0,0 @@
Variable objects
Copy link
Member Author

@TomNicholas TomNicholas Jul 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of this content has been kept - it's been moved to internal-design.rst. I'm not sure why git mv didn't seem to understand that I was just renaming this file.

@TomNicholas TomNicholas mentioned this pull request Jul 17, 2023
4 tasks

.. ipython:: python

var.data
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These examples print long reprs of the numpy arrays, but irritatingly np.set_printoptions(threshold=10) doesn't seem to do anything when I try it locally.

Copy link
Collaborator

@headtr1ck headtr1ck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good addition!

doc/internals/extending-xarray.rst Show resolved Hide resolved
doc/internals/internal-design.rst Outdated Show resolved Hide resolved
TomNicholas and others added 3 commits July 24, 2023 09:42
@TomNicholas
Copy link
Member Author

TomNicholas commented Jul 25, 2023

@pydata/xarray any other opinions on this? Thoughts on any other parts of xarray's internals that might be useful to explain?

Copy link
Collaborator

@headtr1ck headtr1ck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since #7368 Coordinates is now public API, but still used internally. Not sure if there is much to explain though.

doc/internals/internal-design.rst Outdated Show resolved Hide resolved
doc/internals/index.rst Outdated Show resolved Hide resolved
TomNicholas and others added 2 commits August 3, 2023 12:07
Co-authored-by: Michael Niklas  <mick.niklas@gmail.com>
@TomNicholas TomNicholas enabled auto-merge (squash) August 3, 2023 16:20
@headtr1ck headtr1ck added plan to merge Final call for comments and removed needs review labels Aug 13, 2023
@dcherian dcherian merged commit 67268f1 into pydata:main Sep 8, 2023
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants