Small documentation fixes #1516
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
max-sixty
reviewed
Aug 23, 2017
doc/data-structures.rst
Outdated
| @@ -48,7 +48,7 @@ The :py:class:`~xarray.DataArray` constructor takes: | |||
| :py:class:`~pandas.Series`, :py:class:`~pandas.DataFrame` or :py:class:`~pandas.Panel`) | |||
| - ``coords``: a list or dictionary of coordinates | |||
| - ``dims``: a list of dimension names. If omitted, dimension names are | |||
| taken from ``coords`` if possible. | |||
| taken from ``coords`` if possible (deprecated). | |||
There was a problem hiding this comment.
I would vote to remove the deprecated behavior from the docs
There was a problem hiding this comment.
Rather than "if possible" I would say "if coords was provided as a list"
(I think that's the only case where it's supported now.)
There was a problem hiding this comment.
@shoyer when speaking of list, do you mean a list of tuples (name, [coordinates..])?
There was a problem hiding this comment.
Great. I have updated the PR accordingly. It seems the format of the list was previously not documented.
|
Thanks |
shoyer
pushed a commit
that referenced
this pull request
Sep 1, 2017
* Add pathlib support * Loop over tmpfile functions * Added show_commit_url to asv.conf (#1515) * Added show_commit_url to asv.conf This should setup the proper links from the published output to the commit on Github. FYI the benchmarks should be running stably now, and posted to http://pandas.pydata.org/speed/xarray. http://pandas.pydata.org/speed/xarray/regressions.xml has an RSS feed to the regressions. * Update asv.conf.json * Small documentation fixes (#1516) * Clarify in docs that inferring DataArray dimensions is deprecated * Fix DataArray docstring * Clarify DataArray coords documentation * Condense pathlib handling for open_mf_dataset * Add and test pathlib support for backends * Add pathlib2 for python < 3 * Use pathlib backport if available. This follows <jazzband/pathlib2#8 (comment)> who argues for sticking to pathlib2. * Use pathlib w DataArray.to_netcdf * Handle case of completely missing pathlib * Remove pathlib requirement * Drop pathlib from minimal test env * Add what's-new entry on pathlib support * Prefer stdlib pathlib * Suppress ImportError's for pathlib * Acutally get suppress function * Add decorator for tests requiring pathlib(2) * Move path_type to central submodule * Remove unnecessary parens * Revert "Added show_commit_url to asv.conf (#1515)" This reverts commit 02023ed. * Revert "Small documentation fixes (#1516)" This reverts commit 4276bb8. * Fix typo in docstring and fallback-module name * Tweak what's new for pathlib support
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.
coordshas been deprecated.