Merge pull request #773 from DHI/missing_class_docstrings

Added missing class level one-line summary docstring.

Author: ecomodeller

mikeio/dataset/_data_plot.py

@@ -847,6 +847,8 @@ def __init__(self, da: DataArray) -> None:
 
 
 class _DatasetPlotter:
+    """Class for plotting scatter plots from datasets."""
+
     def __init__(self, ds: Dataset) -> None:
         self.ds = ds
 

mikeio/dfs/_dfs0.py

@@ -82,6 +82,8 @@ def _write_dfs0(
 
 
 class Dfs0:
+    """Class for reading/writing dfs0 files."""
+
     def __init__(self, filename: str | Path):
         """Create a Dfs0 object for reading, writing.
 

mikeio/dfs/_dfs1.py

@@ -66,6 +66,8 @@ def _write_dfs1_header(filename: str | Path, ds: Dataset, title: str) -> DfsFile
 
 
 class Dfs1(_Dfs123):
+    """Class for reading/writing dfs1 files."""
+
     _ndim = 1
 
     def __init__(self, filename: str | Path) -> None:

mikeio/dfs/_dfs2.py

@@ -108,6 +108,8 @@ def _write_dfs2_spatial_axis(
 
 
 class Dfs2(_Dfs123):
+    """Class for reading/writing dfs2 files."""
+
     _ndim = 2
 
     def __init__(

mikeio/dfs/_dfs3.py

@@ -99,6 +99,8 @@ def _write_dfs3_header(filename: str | Path, ds: Dataset, title: str) -> DfsFile
 
 
 class Dfs3(_Dfs123):
+    """Class for reading/writing dfs3 files."""
+
     _ndim = 3
 
     def __init__(self, filename: str | Path):

mikeio/dfsu/_dfsu.py

@@ -278,6 +278,8 @@ def _get_dfsu_info(filename: str | Path) -> _DfsuInfo:
 
 
 class Dfsu2DH:
+    """Class for reading/writing dfsu 2d horizontal files."""
+
     show_progress = False
 
     def __init__(self, filename: str | Path) -> None:

mikeio/dfsu/_factory.py

@@ -37,5 +37,7 @@ def dfsu(filename: str | Path) -> Any:
 
 
 class Dfsu:
+    """Factory class for dfsu files."""
+
     def __new__(self, filename: str | Path) -> Any:
         return dfsu(filename)

mikeio/dfsu/_layered.py

@@ -411,6 +411,8 @@ def append(self, ds: Dataset, validate: bool = True) -> None:
 
 
 class Dfsu2DV(DfsuLayered):
+    """Class for reading/writing dfsu 2d vertical files."""
+
     def plot_vertical_profile(
         self,
         values: np.ndarray | DataArray,
@@ -465,6 +467,8 @@ def plot_vertical_profile(
 
 
 class Dfsu3D(DfsuLayered):
+    """Class for reading/writing dfsu 3d files."""
+
     @property
     def geometry2d(self) -> GeometryFM2D:
         """The 2d geometry for a 3d object."""

mikeio/dfsu/_spectral.py

@@ -26,6 +26,8 @@
 
 
 class DfsuSpectral:
+    """Dfsu for Spectral data."""
+
     show_progress = False
 
     def __init__(self, filename: str | Path) -> None:

mikeio/eum/_eum.py

@@ -1399,7 +1399,7 @@ def __repr__(self) -> str:
 
 
 class ItemInfo:
-    """ItemInfo.
+    """Info for dynamicc items (variables).
 
     Parameters
     ----------