DOC: small improvements to the netCDF docs #1169
Merged
Conversation
This file contains hidden or 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
shoyer
reviewed
Dec 17, 2016
| Formats supported by Pandas | ||
| --------------------------- | ||
|
|
||
| For more options, consider exporting your objects to pandas |
There was a problem hiding this comment.
Let's call CSV and other tabular formats in particular.
| netCDF because xarray was based on the netCDF data model, so netCDF files on disk | ||
| The recommended way to store xarray objects is `netCDF`__. | ||
| netCDF is a file format for fully self-described datasets that | ||
| is widely used and supported on almost all platforms. xarray is based on the |
There was a problem hiding this comment.
I agree with the sentiment here, but I think it might still be a good idea to mention at least that netCDF "originated in the geosciences".
shoyer
reviewed
Dec 17, 2016
| is widely used in the geosciences and supported on almost all platforms. We use | ||
| netCDF because xarray was based on the netCDF data model, so netCDF files on disk | ||
| The recommended way to store xarray objects is `netCDF`__. | ||
| netCDF is a file format for fully self-described datasets that |
|
Thanks! Updated |
This was referenced Dec 24, 2016
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.
Partly addresses #768 (comment) and #1154, mostly by making the tone less defensive. I also added that we recommend the netCDF format for IO. (I think that the format is powerful enough for being useful in other disciplines than geosciences).
I agree with @rabernat that the current page title (Serialization and IO) could be changed to something more accessible, but I don't know how. Two possibilities, both quite long (it looks a bit ugly on RTD):