Remove unnecessary redundant statement ('Class') from Class docstrings to match Google style guide

Author: kysolvik

dabench/data/_barotropic.py

@@ -30,9 +30,9 @@
 
 
 class Barotropic(_data.Data):
-    """ Class to set up barotropic model
+    """Barotropic model data generator based on pyqg
 
-    The data class is a wrapper of a "optional" pyqg package.
+    This data class is a wrapper of a "optional" pyqg package.
     See https://pyqg.readthedocs.io
 
     Notes:

dabench/data/_data.py

@@ -16,7 +16,7 @@
 ArrayLike = np.ndarray | jax.Array
 
 class Data():
-    """Generic class for data generator objects.
+    """Base for all data generator objects.
 
     Args:
         system_dim: system dimension

dabench/data/_enso_indices.py

@@ -14,7 +14,7 @@
 
 
 class ENSOIndices(_data.Data):
-    """Class to get ENSO indices from CPC website
+    """Gets ENSO indices from CPC website
 
     Notes:
         Source: https://www.cpc.ncep.noaa.gov/data/indices/

dabench/data/_gcp.py

@@ -18,7 +18,7 @@
 
 
 class GCP(_data.Data):
-    """Class for loading ERA5 data from Google Cloud Platform
+    """Loads ERA5 data from Google Cloud Platform
 
     Notes:
         Source: https://cloud.google.com/storage/docs/public-datasets/era5

dabench/data/_lorenz63.py

@@ -13,7 +13,7 @@
 ArrayLike = np.ndarray | jax.Array
 
 class Lorenz63(_data.Data):
-    """ Class to set up Lorenz 63 model data
+    """Lorenz 63 model data generator.
 
     Args:
         sigma: Lorenz 63 param. Default is 10., the original value

dabench/data/_lorenz96.py

@@ -13,7 +13,7 @@
 
 
 class Lorenz96(_data.Data):
-    """Class to set up Lorenz 96 model data.
+    """Lorenz 96 model data generator.
 
     Notes:
         Default values come from Lorenz, 1996:

dabench/data/_pyqg.py

@@ -25,7 +25,7 @@
 
 
 class PyQG(_data.Data):
-    """ Class to set up quasi-geotropic model
+    """PyQG quasi-geotropic model data generator.
 
     The PyQG class is simply a wrapper of a "optional" pyqg package.
     See https://pyqg.readthedocs.io

dabench/data/_pyqg_jax.py

@@ -32,7 +32,7 @@
 
 
 class PyQGJax(_data.Data):
-    """Class to set up quasi-geotropic model
+    """PyQGJax quasi-geotropic model data generator.
 
     The PyQGJax class is simply a wrapper of the "optional" pyqg-jax package.
     See https://pyqg-jax.readthedocs.io

dabench/data/_qgs.py

@@ -33,7 +33,7 @@
 
 
 class QGS(_data.Data):
-    """ Class to set up QGS quasi-geostrophic model
+    """QGS quasi-geostrophic model data generator.
 
     The QGS class is simply a wrapper of an *optional* qgs package.
     See https://qgs.readthedocs.io/

dabench/data/_sqgturb.py

@@ -50,7 +50,7 @@
 
 
 class SQGTurb(_data.Data):
-    """Class to set up SQGTurb model and manage data.
+    """SQGTurb model data generator.
 
     Args:
         pv: Potential vorticity array. If None (default),