Skip to content

Commit

Permalink
docs(groupby): mention deprecation of squeeze kwarg (#9625)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Sibgatulin authored Oct 15, 2024
1 parent 97799e8 commit c3dabe1
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions xarray/core/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -10376,10 +10376,8 @@ def groupby(
Array whose unique values should be used to group this array. If a
Hashable, must be the name of a coordinate contained in this dataarray. If a dictionary,
must map an existing variable name to a :py:class:`Grouper` instance.
squeeze : bool, default: True
If "group" is a dimension of any arrays in this dataset, `squeeze`
controls whether the subarrays have a dimension of length 1 along
that dimension or if the dimension is squeezed out.
squeeze : False
This argument is deprecated.
restore_coord_dims : bool, default: False
If True, also restore the dimension order of multi-dimensional
coordinates.
Expand Down

0 comments on commit c3dabe1

Please sign in to comment.