Merge pull request #2153 from gerritholl/improve-docs-finest

Document alternative for get_min/max_area
pytroll · Aug 2, 2022 · fc66d32 · fc66d32
2 parents 7e76b5e + d4f8ddc
commit fc66d32
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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