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

Refer to open_zarr in open_dataset docstring #7438

Merged
merged 4 commits into from
Jan 13, 2023

Conversation

paigem
Copy link
Contributor

@paigem paigem commented Jan 13, 2023

This adds a sentence (below) under "chunks" in doctoring of open_dataset() to clarify current usage for those who want the same behavior as open_zarr() used to provide:

In order to reproduce the default behavior of xr.open_zarr(...) use `xr.open_dataset(..., engine='zarr', chunks={})`.

xarray/backends/api.py Outdated Show resolved Hide resolved
@dcherian
Copy link
Contributor

Just a small newline addition. Thanks @paigem

@dcherian dcherian enabled auto-merge (squash) January 13, 2023 20:29
@dcherian dcherian changed the title Add sentence to open_dataset docstring Refer to open_zarr to open_dataset docstring Jan 13, 2023
@dcherian dcherian changed the title Refer to open_zarr to open_dataset docstring Refer to open_zarr in open_dataset docstring Jan 13, 2023
@dcherian dcherian merged commit b741d83 into pydata:main Jan 13, 2023
dcherian added a commit to dcherian/xarray that referenced this pull request Jan 18, 2023
* main: (41 commits)
  v2023.01.0 whats-new (pydata#7440)
  explain keep_attrs in docstring of apply_ufunc (pydata#7445)
  Add sentence to open_dataset docstring (pydata#7438)
  pin scipy version in doc environment (pydata#7436)
  Improve performance for backend datetime handling (pydata#7374)
  fix typo (pydata#7433)
  Add lazy backend ASV test (pydata#7426)
  Pull Request Labeler - Workaround sync-labels bug (pydata#7431)
  see also : groupby in resample doc and vice-versa (pydata#7425)
  Some alignment optimizations (pydata#7382)
  Make `broadcast` and `concat` work with the Array API (pydata#7387)
  remove `numbagg` and `numba` from the upstream-dev CI (pydata#7416)
  [pre-commit.ci] pre-commit autoupdate (pydata#7402)
  Preserve original dtype when accessing MultiIndex levels (pydata#7393)
  [pre-commit.ci] pre-commit autoupdate (pydata#7389)
  [pre-commit.ci] pre-commit autoupdate (pydata#7360)
  COMPAT: Adjust CFTimeIndex.get_loc for pandas 2.0 deprecation enforcement (pydata#7361)
  Avoid loading entire dataset by getting the nbytes in an array (pydata#7356)
  `keep_attrs` for pad (pydata#7267)
  Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.6.4 (pydata#7375)
  ...
@jhamman jhamman mentioned this pull request Jan 31, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify that chunks={} in .open_dataset reproduces the default behavior of deprecated .open_zarr
2 participants