From 05bf44be005c9ec453546197b33d11a4af43e0e5 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Thu, 23 Feb 2023 16:16:36 -0800 Subject: [PATCH 1/4] DOC: cross ref the groupby tutorial --- xarray/core/dataarray.py | 4 +++- xarray/core/dataset.py | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py index f6db654bdf6..f453edb6940 100644 --- a/xarray/core/dataarray.py +++ b/xarray/core/dataarray.py @@ -6205,6 +6205,7 @@ def groupby( restore_coord_dims: bool = False, ) -> DataArrayGroupBy: """Returns a DataArrayGroupBy object for performing grouped operations. + See more details at :ref:`groupby`. Parameters ---------- @@ -6285,7 +6286,8 @@ def groupby_bins( """Returns a DataArrayGroupBy object for performing grouped operations. Rather than using all unique values of `group`, the values are discretized - first by applying `pandas.cut` [1]_ to `group`. + first by applying `pandas.cut` [1]_ to `group`. See more details at + :ref:`groupby`. Parameters ---------- diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index 030d678b6f4..ab4bfe334d0 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -8911,6 +8911,7 @@ def groupby( restore_coord_dims: bool = False, ) -> DatasetGroupBy: """Returns a DatasetGroupBy object for performing grouped operations. + See more details at :ref:`groupby`. Parameters ---------- @@ -8969,6 +8970,7 @@ def groupby_bins( restore_coord_dims: bool = False, ) -> DatasetGroupBy: """Returns a DatasetGroupBy object for performing grouped operations. + See more details at :ref:`groupby`. Rather than using all unique values of `group`, the values are discretized first by applying `pandas.cut` [1]_ to `group`. From b6759805af7f6ef115d9f371159601b48fa567cf Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Thu, 23 Feb 2023 21:41:41 -0800 Subject: [PATCH 2/4] DOC: cross ref the groupby tutorial --- xarray/core/dataarray.py | 6 +++--- xarray/core/dataset.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py index f453edb6940..82c4a4667a7 100644 --- a/xarray/core/dataarray.py +++ b/xarray/core/dataarray.py @@ -6205,7 +6205,6 @@ def groupby( restore_coord_dims: bool = False, ) -> DataArrayGroupBy: """Returns a DataArrayGroupBy object for performing grouped operations. - See more details at :ref:`groupby`. Parameters ---------- @@ -6250,6 +6249,7 @@ def groupby( See Also -------- + :ref:`groupby` DataArray.groupby_bins Dataset.groupby core.groupby.DataArrayGroupBy @@ -6286,8 +6286,7 @@ def groupby_bins( """Returns a DataArrayGroupBy object for performing grouped operations. Rather than using all unique values of `group`, the values are discretized - first by applying `pandas.cut` [1]_ to `group`. See more details at - :ref:`groupby`. + first by applying `pandas.cut` [1]_ to `group`. Parameters ---------- @@ -6330,6 +6329,7 @@ def groupby_bins( See Also -------- + :ref:`groupby` DataArray.groupby Dataset.groupby_bins core.groupby.DataArrayGroupBy diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index ab4bfe334d0..5cecbe4726b 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -8911,7 +8911,6 @@ def groupby( restore_coord_dims: bool = False, ) -> DatasetGroupBy: """Returns a DatasetGroupBy object for performing grouped operations. - See more details at :ref:`groupby`. Parameters ---------- @@ -8934,6 +8933,7 @@ def groupby( See Also -------- + :ref:`groupby` Dataset.groupby_bins DataArray.groupby core.groupby.DatasetGroupBy @@ -8970,7 +8970,6 @@ def groupby_bins( restore_coord_dims: bool = False, ) -> DatasetGroupBy: """Returns a DatasetGroupBy object for performing grouped operations. - See more details at :ref:`groupby`. Rather than using all unique values of `group`, the values are discretized first by applying `pandas.cut` [1]_ to `group`. @@ -9016,6 +9015,7 @@ def groupby_bins( See Also -------- + :ref:`groupby` Dataset.groupby DataArray.groupby_bins core.groupby.DatasetGroupBy From f557b9c3e73e793211affe5f19484b613de15648 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Thu, 23 Feb 2023 21:46:05 -0800 Subject: [PATCH 3/4] DOC: change groupby ref description --- xarray/core/dataarray.py | 4 ++-- xarray/core/dataset.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py index 82c4a4667a7..7fa5e5a8ed1 100644 --- a/xarray/core/dataarray.py +++ b/xarray/core/dataarray.py @@ -6249,7 +6249,7 @@ def groupby( See Also -------- - :ref:`groupby` + :ref:`Users guide: group and bin data ` DataArray.groupby_bins Dataset.groupby core.groupby.DataArrayGroupBy @@ -6329,7 +6329,7 @@ def groupby_bins( See Also -------- - :ref:`groupby` + :ref:`Users guide: group and bin data ` DataArray.groupby Dataset.groupby_bins core.groupby.DataArrayGroupBy diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index 5cecbe4726b..ad6f04288cc 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -8933,7 +8933,7 @@ def groupby( See Also -------- - :ref:`groupby` + :ref:`Users guide: group and bin data ` Dataset.groupby_bins DataArray.groupby core.groupby.DatasetGroupBy @@ -9015,7 +9015,7 @@ def groupby_bins( See Also -------- - :ref:`groupby` + :ref:`Users guide: group and bin data ` Dataset.groupby DataArray.groupby_bins core.groupby.DatasetGroupBy From 01f3653cda02ac6ed3fb870cf0e3d5871edb88ad Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Fri, 24 Feb 2023 08:05:22 -0800 Subject: [PATCH 4/4] DOC: change groupby ref description --- xarray/core/dataarray.py | 6 ++++-- xarray/core/dataset.py | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py index 7fa5e5a8ed1..1f04f506397 100644 --- a/xarray/core/dataarray.py +++ b/xarray/core/dataarray.py @@ -6249,7 +6249,8 @@ def groupby( See Also -------- - :ref:`Users guide: group and bin data ` + :ref:`groupby` + Users guide explanation of how to group and bin data. DataArray.groupby_bins Dataset.groupby core.groupby.DataArrayGroupBy @@ -6329,7 +6330,8 @@ def groupby_bins( See Also -------- - :ref:`Users guide: group and bin data ` + :ref:`groupby` + Users guide explanation of how to group and bin data. DataArray.groupby Dataset.groupby_bins core.groupby.DataArrayGroupBy diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py index ad6f04288cc..37e78607904 100644 --- a/xarray/core/dataset.py +++ b/xarray/core/dataset.py @@ -8933,7 +8933,8 @@ def groupby( See Also -------- - :ref:`Users guide: group and bin data ` + :ref:`groupby` + Users guide explanation of how to group and bin data. Dataset.groupby_bins DataArray.groupby core.groupby.DatasetGroupBy @@ -9015,7 +9016,8 @@ def groupby_bins( See Also -------- - :ref:`Users guide: group and bin data ` + :ref:`groupby` + Users guide explanation of how to group and bin data. Dataset.groupby DataArray.groupby_bins core.groupby.DatasetGroupBy