DOC: refresh "Why xarray" and shorten top-level description #2657
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This documentation revamp builds upon rabernat's rewrite in GH2430. The main change is that the three paragraph description felt too long to me, so I moved the background paragraph on multi-dimensional arrays into the next section, on "Why xarray". I also ended up rewriting most of that page, and made a few adjustments to the FAQ and related projects pages.
rabernat
approved these changes
Jan 7, 2019
doc/faq.rst
Outdated
| dimensional data structures. | ||
|
|
||
| Pandas gets a lot of things right, but scientific users (and many others) need | ||
| fully multi-dimensional data structures. |
There was a problem hiding this comment.
Maybe a good place to explicitly mention deep learning libraries?
doc/why-xarray.rst
Outdated
| they have labels which encode information about how the array values map | ||
| to locations in space, time, etc. | ||
|
|
||
| Xarray doesn't just keep track of labels on arrays: it uses them to provide a |
There was a problem hiding this comment.
nit: use a dash instead of a colon
|
LGTM but I'll hold off on clicking merge. Apologies for merging too quickly the last time around. |
dcherian
pushed a commit
to dcherian/xarray
that referenced
this pull request
Jan 14, 2019
* upstream/master: xfail cftimeindex multiindex test (pydata#2669) DOC: refresh "Why xarray" and shorten top-level description (pydata#2657) Remove broken Travis-CI builds (pydata#2661) Type checking with mypy (pydata#2655) Added Coarsen (pydata#2612)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documentation revamp builds upon @rabernat's rewrite in #2430.
The main change is that the three paragraph description felt too long to me, so I moved the background paragraph on multi-dimensional arrays into the next section, on "Why xarray". I also ended up rewriting most of that page, and made a few adjustments to the FAQ and related projects pages.