From d4f8ddc5dc31d6a8aea1cca5e1d7c14e597fd5d7 Mon Sep 17 00:00:00 2001 From: Gerrit Holl Date: Fri, 29 Jul 2022 17:33:26 +0200 Subject: [PATCH] Document alternative for get_min/max_area In the docstring for get_min_area and get_max_area, do not only write that they are deprecated, but also write what should be used instead. --- satpy/scene.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/satpy/scene.py b/satpy/scene.py index 41bb77b94a..dd1ca61dcd 100644 --- a/satpy/scene.py +++ b/satpy/scene.py @@ -316,6 +316,8 @@ def finest_area(self, datasets=None): def max_area(self, datasets=None): """Get highest resolution area for the provided datasets. Deprecated. + Deprecated. Use :meth:`finest_area` instead. + Args: datasets (iterable): Datasets whose areas will be compared. Can be either `xarray.DataArray` objects or @@ -342,6 +344,8 @@ def coarsest_area(self, datasets=None): def min_area(self, datasets=None): """Get lowest resolution area for the provided datasets. Deprecated. + Deprecated. Use :meth:`coarsest_area` instead. + Args: datasets (iterable): Datasets whose areas will be compared. Can be either `xarray.DataArray` objects or