Skip to content

Commit c3dabe1

Browse files
authored
docs(groupby): mention deprecation of squeeze kwarg (#9625)
As mentioned in #2157, the docstring of `Dataset.groupby` does not reflect deprecation of squeeze (as the docstring of `DataArray.groupby` does) and states an incorrect default value.
1 parent 97799e8 commit c3dabe1

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

xarray/core/dataset.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10376,10 +10376,8 @@ def groupby(
1037610376
Array whose unique values should be used to group this array. If a
1037710377
Hashable, must be the name of a coordinate contained in this dataarray. If a dictionary,
1037810378
must map an existing variable name to a :py:class:`Grouper` instance.
10379-
squeeze : bool, default: True
10380-
If "group" is a dimension of any arrays in this dataset, `squeeze`
10381-
controls whether the subarrays have a dimension of length 1 along
10382-
that dimension or if the dimension is squeezed out.
10379+
squeeze : False
10380+
This argument is deprecated.
1038310381
restore_coord_dims : bool, default: False
1038410382
If True, also restore the dimension order of multi-dimensional
1038510383
coordinates.

0 commit comments

Comments
 (0)