Skip to content

Commit

Permalink
Document alternative for get_min/max_area
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gerritholl committed Jul 29, 2022
1 parent 4235d35 commit d4f8ddc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions satpy/scene.py
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit d4f8ddc

Please sign in to comment.