Skip to content

Commit

Permalink
Improve docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiggi committed Feb 7, 2024
1 parent c23d659 commit 52d8794
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions gpm_api/utils/checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ def get_slices_valid_geolocation(xr_obj, min_size=2):


def get_slices_non_valid_geolocation(xr_obj):
"""Return a list of along-track slices with non-valid geolocation.
"""Return a list of GPM ORBIT along-track slices with non-valid geolocation.
The minimum size of the output slices is 2.
Expand Down Expand Up @@ -737,7 +737,7 @@ def has_valid_geolocation(xr_obj):


def apply_on_valid_geolocation(function):
"""A decorator that apply the get_slices_<function> only on portions
"""A decorator that apply the get_slices_<function> only on portions of GPM ORBIT objects
with valid geolocation."""

@functools.wraps(function)
Expand Down Expand Up @@ -819,7 +819,7 @@ def _get_non_wobbling_lats(lats, threshold=100):

@apply_on_valid_geolocation
def get_slices_non_wobbling_swath(xr_obj, threshold=100):
"""Return the along-track slices along which the swath is not wobbling.
"""Return the GPM ORBIT along-track slices along which the swath is not wobbling.
For wobbling, we define the occurrence of changes in latitude directions
in less than `threshold` scans.
Expand All @@ -842,7 +842,7 @@ def get_slices_non_wobbling_swath(xr_obj, threshold=100):

@apply_on_valid_geolocation
def get_slices_wobbling_swath(xr_obj, threshold=100):
"""Return the along-track slices along which the swath is wobbling.
"""Return the GPM ORBIT along-track slices along which the swath is wobbling.
For wobbling, we define the occurrence of changes in latitude directions
in less than `threshold` scans.
Expand Down

0 comments on commit 52d8794

Please sign in to comment.