Skip to content

Duck array documentation improvements - #7911

Merged
TomNicholas merged 41 commits into
pydata:mainfrom
TomNicholas:duckarray-docs
Jun 29, 2023
Merged

Duck array documentation improvements#7911
TomNicholas merged 41 commits into
pydata:mainfrom
TomNicholas:duckarray-docs

Conversation

@TomNicholas

@TomNicholasTomNicholas commented Jun 12, 2023•
edited
Loading

Copy link
Copy Markdown
Member

Draft improvements to the user guide page on using duck arrays.

Intended as part of the scipy tutorial effort, though I wasn't sure whether to concentrate on content in the main xarray docs or the tutorial repo.

(I wrote this on a train without enough internet to update my conda environment so I will come back and fix anything that doesn't run.)

cc @dcherian and @keewis

@TomNicholasTomNicholas added topic-documentation topic-arrays related to flexible array support labels Jun 12, 2023
@github-actionsgithub-actionsBot removed the topic-arrays related to flexible array support label Jun 12, 2023
dcherian
dcherian reviewed Jun 14, 2023
View reviewed changes

@dcheriandcherian left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @TomNicholas

Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst
Comment threaddoc/user-guide/duckarrays.rst Outdated
@TomNicholasTomNicholas added the topic-arrays related to flexible array support label Jun 27, 2023
dcherian
dcherian approved these changes Jun 28, 2023
View reviewed changes

@dcheriandcherian left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! Thanks Tom, this is a great addition. Just some minor comments.

Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/duck-arrays-integration.rst Outdated
Comment threaddoc/internals/index.rst
Comment threaddoc/user-guide/duckarrays.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst
Comment threaddoc/user-guide/duckarrays.rst Outdated
Comment threaddoc/user-guide/duckarrays.rst Outdated
@TomNicholas@dcherian
double that
0b405a1
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@github-actionsgithub-actionsBot removed the topic-arrays related to flexible array support label Jun 28, 2023
TomNicholasand others added 17 commits June 28, 2023 17:14
@TomNicholas@dcherian
numpy array class clarification
ed6195c
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
Remove sentence about xarray's internals
40eb53b
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
array API standard
a567aa4
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
proper link for sparse.COO type
76237a9
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
links to docstrings of array types
1923d4b
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
don't put variable in parentheses
b26cbd8
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
double backquote formatting
f62b4a9
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas@dcherian
better bracketing
8d4bd3f
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas
fix list formatting
e9287de
@TomNicholas
add links to glue packages, dask, and cubed
d1e9b8f
@TomNicholas
Merge branch 'duckarray-docs' ofhttps://github.com/TomNicholas/xarray…
d545d5d
…into duckarray-docs
@TomNicholas@dcherian
link to todense method
1ea2078
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
@TomNicholas
link to numpy-like arrays page
be919b6
@TomNicholas
Merge branch 'duckarray-docs' ofhttps://github.com/TomNicholas/xarray…
0c0a547
…into duckarray-docs
@TomNicholas
link to numpy ufunc docs
d03e125
@TomNicholas
add example of using .to_numpy
90a8bcb
@TomNicholas
show example of .values failing
14057b9
@TomNicholasTomNicholas mentioned this pull request Jun 28, 2023
Merged
4 tasks
@TomNicholas
TomNicholas enabled auto-merge (squash) June 29, 2023 14:38
@TomNicholas
TomNicholas disabled auto-merge June 29, 2023 14:38
@TomNicholas
TomNicholas merged commit 4b54421 into pydata:mainJun 29, 2023
@TomNicholasTomNicholas mentioned this pull request Jul 7, 2023
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dcheriandcheriandcherian approved these changes

Assignees

No one assigned

Labels

topic-documentationtopic-faq

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@TomNicholas@dcherian