-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Improve the documentation of swap_dims #3331
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!!
Do you want to add a whatsnew and give yourself credit?
done. The error in building the docs seems to have something to do with plotting and "tight_layout" (the reason is the warning from |
Thanks @keewis! Yes that failure looks unrelated. |
Thanks @keewis! |
* upstream/master: (43 commits) Add hypothesis support to related projects (#3335) More doc fixes (#3333) Improve the documentation of swap_dims (#3331) fix the doc names of the return value of swap_dims (#3329) Fix isel performance regression (#3319) Allow weakref (#3318) Clarify that "scatter" is a plotting method in what's new. (#3316) Fix whats-new date :/ Revert to dev version Release v0.13.0 auto_combine deprecation to 0.14 (#3314) Deprecation: groupby, resample default dim. (#3313) Raise error if cmap is list of colors (#3310) Refactor concat to use merge for non-concatenated variables (#3239) Honor `keep_attrs` in DataArray.quantile (#3305) Fix DataArray api doc (#3309) Accept int value in head, thin and tail (#3298) ignore h5py 2.10.0 warnings and fix invalid_netcdf warning test. (#3301) Update why-xarray.rst with clearer expression (#3307) Compat and encoding deprecation to 0.14 (#3294) ...
* upstream/master: Remove setting of universal wheels (pydata#3367) Revisit # noqa annotations (pydata#3359) Fix codecov.io upload on Windows (pydata#3360) Add how do I ... section (pydata#3357) Add glossary to documentation (pydata#3352) Documentation improvements (pydata#3328) Remove `complex.nc` from built docs (pydata#3353) Fix DataArray.to_netcdf type annotation (pydata#3325) CI test suites with pinned minimum dependencies (pydata#3346) Bugfix/plot accept coord dim (pydata#3345) CI environments overhaul (pydata#3340) Add hypothesis support to related projects (pydata#3335) More doc fixes (pydata#3333) Improve the documentation of swap_dims (pydata#3331) fix the doc names of the return value of swap_dims (pydata#3329)
This adds examples to both
Dataset.swap_dims
andDataArray.swap_dims
(and fixes an oversight on my part in #3329).From #2838, it seems that there was the intention to rename it, but as far as I can tell, that decision is not official yet (and
Dataset
even got its own newrename_dims
).black . && mypy . && flake8
whats-new.rst
for all changes andapi.rst
for new API