Fix class docstrings to remove redundant 'Class' statement, based on Google style guide

kysolvik · kysolvik · commit 1429fcc3d972 · 2025-04-19T16:37:42.000-06:00
diff --git a/dabench/dacycler/_dacycler.py b/dabench/dacycler/_dacycler.py
@@ -16,7 +16,7 @@
 XarrayDatasetLike = xr.Dataset | xj.XjDataset
 
 class DACycler():
-    """Base class for DACycler object
+    """Base for all DACyclers
 
     Args:
         system_dim: System dimension
diff --git a/dabench/dacycler/_etkf.py b/dabench/dacycler/_etkf.py
@@ -17,7 +17,7 @@
 XarrayDatasetLike = xr.Dataset | xj.XjDataset
 
 class ETKF(dacycler.DACycler):
-    """Class for building ETKF DA Cycler
+    """Ensemble transform Kalman filter DA Cycler
 
     Args:
         system_dim: System dimension.
diff --git a/dabench/dacycler/_var3d.py b/dabench/dacycler/_var3d.py
@@ -16,7 +16,7 @@
 XarrayDatasetLike = xr.Dataset | xj.XjDataset
 
 class Var3D(dacycler.DACycler):
-    """Class for building 3DVar DA Cycler
+    """3D-Var DA Cycler
 
     Args:
         system_dim: System dimension.
diff --git a/dabench/dacycler/_var4d.py b/dabench/dacycler/_var4d.py
@@ -25,7 +25,7 @@
 XarrayDatasetLike = xr.Dataset | xj.XjDataset
 
 class Var4D(dacycler.DACycler):
-    """Class for building 4D DA Cycler
+    """4D-Var DA Cycler
 
     Args:
         system_dim: System dimension.
diff --git a/dabench/dacycler/_var4d_backprop.py b/dabench/dacycler/_var4d_backprop.py
@@ -25,7 +25,7 @@
 ScheduleState = Any
 
 class Var4DBackprop(dacycler.DACycler):
-    """Class for building Backpropagation 4D DA Cycler
+    """Backpropagation 4D-Var DA Cycler
 
     Args:
         system_dim: System dimension.
