Add and fix pydocstyle rules

gpm/__init__.py

@@ -24,6 +24,8 @@
 # SOFTWARE.
 
 # -----------------------------------------------------------------------------.
+"""GPM-API Package."""
+
 import contextlib
 import os
 from importlib.metadata import PackageNotFoundError, version

gpm/_config.py

@@ -24,7 +24,7 @@
 # SOFTWARE.
 
 # -----------------------------------------------------------------------------.
-"""This module create a donfig utility
+"""Donfig configuration utility.
 
 See https://donfig.readthedocs.io/en/latest/configuration.html for more info.
 """

gpm/bucket/processing.py

@@ -318,7 +318,7 @@ def merge_granule_buckets(
     batch_readahead=16,
     fragment_readahead=4,
 ):
-    """Merge the per-granule bucket archive in a single optimized archive !
+    """Merge the per-granule bucket archive in a single optimized archive.
 
     Parameters
     ----------

gpm/configs.py

@@ -24,7 +24,7 @@
 # SOFTWARE.
 
 # -----------------------------------------------------------------------------.
-"""This module define and retrieve the GPM-API configurations."""
+"""GPM-API configurations settings."""
 import os
 import platform
 from subprocess import Popen

gpm/dataset/attrs.py

@@ -80,8 +80,10 @@
 
 
 def _is_str_list(s):
-    """Return a boolean indicating if the string start and end with brackets and can
-    be converted to a list.
+    """Check if the string start and end with brackets.
+
+    Return a boolean indicating if the string can be converted to a list.
+
     """
     if s.startswith("[") and s.endswith("]"):
         try:
@@ -139,7 +141,7 @@ def _parse_attr_string(s):
 
 
 def decode_string(string):
-    """Decode string dictionary.
+    r"""Decode string dictionary.
 
     Format: ``"<key>=<value>\\n".``.
 
@@ -192,7 +194,7 @@ def get_granule_attrs(dt):
 
 
 def add_history(ds):
-    """Add the history attribute to the xr.Dataset"""
+    """Add the history attribute to the xr.Dataset."""
     current_time = datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S")
     history = f"Created by ghiggi/gpm_api software on {current_time}"
     ds.attrs["history"] = history

gpm/dataset/crs.py

@@ -181,7 +181,7 @@ def _get_projection_coords_attrs(crs):
 
 
 def _get_proj_dim_coords(xr_obj):
-    """Determine the spatial 1D dimensions of the `xarray.DataArray`
+    """Determine the spatial 1D dimensions of the `xarray.DataArray`.
 
     Parameters
     ----------
@@ -227,7 +227,7 @@ def _get_proj_dim_coords(xr_obj):
 
 
 def _get_swath_dim_coords(xr_obj):
-    """Determine the spatial 1D dimensions of the `xarray.DataArray`
+    """Determine the spatial 1D dimensions of the `xarray.DataArray`.
 
     Cases:
     - 2D x/y coordinates with 2 dimensions (along-track-cross-track scan)
@@ -574,7 +574,7 @@ def remove_existing_crs_info(ds):
 
 
 def set_dataset_single_crs(ds, crs, grid_mapping_name="spatial_ref", inplace=False):
-    """Add CF-compliant CRS information to an xr.Dataset
+    """Add CF-compliant CRS information to an xr.Dataset.
 
     It assumes all dataset variables have same CRS !
     For projected CRS, it expects that the CRS dimension coordinates are specified.
@@ -611,7 +611,7 @@ def set_dataset_single_crs(ds, crs, grid_mapping_name="spatial_ref", inplace=Fal
 
 
 def set_dataset_crs(ds, crs, grid_mapping_name="spatial_ref", inplace=False):
-    """Add CF-compliant CRS information to an xr.Dataset
+    """Add CF-compliant CRS information to an xr.Dataset.
 
     It assumes all dataset variables have same CRS !
     For projected CRS, it expects that the CRS dimension coordinates are specified.
@@ -736,6 +736,7 @@ def get_pyproj_crs(xr_obj):
 
 
 def get_pyresample_swath(xr_obj):
+    """Get pyresample SwathDefinition from CF-compliant xarray object."""
     from pyresample import SwathDefinition
 
     if not has_swath_coords(xr_obj):
@@ -765,6 +766,7 @@ def get_pyresample_swath(xr_obj):
 
 def _compute_extent(x_coords, y_coords):
     """Compute the extent (x_min, x_max, y_min, y_max) from the pixel centroids in x and y coordinates.
+
     This function assumes that the spacing between each pixel is uniform.
     """
     # Calculate the pixel size assuming uniform spacing between pixels
@@ -779,6 +781,7 @@ def _compute_extent(x_coords, y_coords):
 
 
 def get_pyresample_projection(xr_obj):
+    """Get pyresample AreaDefinition from CF-compliant xarray object."""
     from pyresample import AreaDefinition
 
     if not has_proj_coords(xr_obj):

gpm/dataset/granule.py

@@ -234,8 +234,7 @@ def open_granule(
     chunks={},
     prefix_group=False,
 ):
-    """Create a lazy ``xarray.Dataset`` with relevant GPM data and attributes
-    for a specific granule.
+    """Create a lazy ``xarray.Dataset`` with relevant GPM data and attributes for a specific granule.
 
     Parameters
     ----------

gpm/io/ges_disc.py

@@ -24,7 +24,7 @@
 # SOFTWARE.
 
 # -----------------------------------------------------------------------------.
-"""This module contains the routines required to search data on the NASA GES DISC servers"""
+"""Routines required to search data on the NASA GES DISC servers."""
 
 import datetime
 import re

gpm/io/pps.py

@@ -63,7 +63,7 @@ def _get_pps_data_server(product_type):
 
 
 def _get_pps_nrt_product_folder_name(product):
-    """ "Retrieve NASA PPS server folder name for NRT product_type."""
+    """Retrieve NASA PPS server folder name for NRT product_type."""
     folder_name = get_product_info(product).get("pps_nrt_dir", None)
     if folder_name is None:
         raise ValueError(
@@ -73,7 +73,7 @@ def _get_pps_nrt_product_folder_name(product):
 
 
 def _get_pps_rs_product_folder_name(product):
-    """ "Retrieve NASA PPS server folder name for RS product_type."""
+    """Retrieve NASA PPS server folder name for RS product_type."""
     folder_name = get_product_info(product).get("pps_rs_dir", None)
     if folder_name is None:
         raise ValueError(