Skip to content
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

Merged
merged 5 commits into from
Sep 22, 2019

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Sep 21, 2019

This adds examples to both Dataset.swap_dims and DataArray.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 new rename_dims).

  • Passes black . && mypy . && flake8
  • Fully documented, including whats-new.rst for all changes and api.rst for new API

@max-sixty max-sixty self-requested a review September 22, 2019 05:11
Copy link
Collaborator

@max-sixty max-sixty left a 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?

@keewis
Copy link
Collaborator Author

keewis commented Sep 22, 2019

done.

The error in building the docs seems to have something to do with plotting and "tight_layout" (the reason is the warning from plotting.rst, line 528: Tight layout not applied. tight_layout cannot make axes height small enough to accommodate all axes decorations), so I guess this is unrelated to my changes?

@max-sixty
Copy link
Collaborator

Thanks @keewis!

Yes that failure looks unrelated.

@max-sixty max-sixty merged commit a5fe56a into pydata:master Sep 22, 2019
@keewis keewis deleted the example-for-swap_dims branch September 22, 2019 16:54
@dcherian
Copy link
Contributor

Thanks @keewis!

dcherian added a commit that referenced this pull request Sep 24, 2019
* 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)
  ...
dcherian added a commit to dcherian/xarray that referenced this pull request Oct 3, 2019
* 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants