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.

Sign up for GitHub

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

Jump to bottom

Refer to open_zarr in open_dataset docstring #7438

Merged
merged 4 commits into from
Jan 13, 2023
Merged

Refer to open_zarr in open_dataset docstring #7438

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d91c4b
Add sentence to open_dataset docstring
paigem Jan 13, 2023
02cbae7
Merge branch 'main' into add-wording-doc-string-open-dataset
paigem Jan 13, 2023
65d7382
Update xarray/backends/api.py
dcherian Jan 13, 2023
93cd752
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion xarray/backends/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,8 @@ def open_dataset(
arrays. ``chunks=-1`` loads the dataset with dask using a single
chunk for all arrays. ``chunks={}`` loads the dataset with dask using
engine preferred chunks if exposed by the backend, otherwise with
a single chunk for all arrays.
a single chunk for all arrays. In order to reproduce the default behavior
of ``xr.open_zarr(...)`` use ``xr.open_dataset(..., engine='zarr', chunks={})``.
``chunks='auto'`` will use dask ``auto`` chunking taking into account the
engine preferred chunks. See dask chunking for more details.
cache : bool, optional
Expand Down