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

Correct save_mfdataset docstring #8934

Merged
merged 2 commits into from
Apr 14, 2024
Merged

Correct save_mfdataset docstring #8934

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
866a896
correct docstring
TomNicholas Apr 12, 2024
dcbc6e1
get type hint right
TomNicholas Apr 12, 2024
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
5 changes: 2 additions & 3 deletions xarray/backends/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1416,8 +1416,6 @@ def save_mfdataset(
these locations will be overwritten.
format : {"NETCDF4", "NETCDF4_CLASSIC", "NETCDF3_64BIT", \
"NETCDF3_CLASSIC"}, optional
**kwargs : additional arguments are passed along to ``to_netcdf``

File format for the resulting netCDF file:

* NETCDF4: Data is stored in an HDF5 file, using netCDF4 API
Expand Down Expand Up @@ -1449,10 +1447,11 @@ def save_mfdataset(
compute : bool
If true compute immediately, otherwise return a
``dask.delayed.Delayed`` object that can be computed later.
**kwargs : dict, optional
Additional arguments are passed along to ``to_netcdf``.

Examples
--------

Save a dataset into one netCDF per year of data:

>>> ds = xr.Dataset(
Expand Down