update mhkit.utils docstring formatting

Author: akeeste

mhkit/utils/stat_utils.py

@@ -5,14 +5,6 @@
 for vector/directional statistics. The module also provides utility functions
 to unwrap vectors, compute magnitudes and phases in 2D/3D, and calculate
 the root mean squared values of vector components.
-
-Functions:
-----------
-- get_statistics: Calculates statistics for continuous data.
-- vector_statistics: Calculates vector mean and standard deviation.
-- unwrap_vector: Unwraps vector data to fall within a 0-360 degree range.
-- magnitude_phase: Computes magnitude and phase for 2D or 3D data.
-- unorm: Computes root mean squared value of 3D vectors.
 """
 
 from typing import List, Dict, Optional, Tuple, Union
@@ -193,7 +185,7 @@ def vector_statistics(
 
 def unwrap_vector(data: Union[pd.Series, np.ndarray, list]) -> np.ndarray:
     """
-    Function used to unwrap vectors into 0-360 deg range
+    Unwraps vector data to a 0-360 degree range.
 
     Parameters
     ------------
@@ -235,7 +227,7 @@ def magnitude_phase(
     Tuple[Union[float, np.ndarray], Union[float, np.ndarray], Union[float, np.ndarray]],
 ]:
     """
-    Retuns magnitude and phase in two or three dimensions.
+    Retuns magnitude and phase for 2D or 3D data.
 
     Parameters
     ----------

mhkit/utils/time_utils.py

@@ -1,11 +1,6 @@
 """
 This module provides utility functions for converting datetime formats
 from MATLAB and Excel to Python datetime formats.
-
-Functions:
-----------
-- matlab_to_datetime: Converts MATLAB datenum format to Python datetime.
-- excel_to_datetime: Converts Excel datenum format to Python datetime.
 """
 
 from typing import Union
@@ -21,7 +16,7 @@ def matlab_to_datetime(
     matlab_datenum: Union[np.ndarray, list, float, int],
 ) -> pd.DatetimeIndex:
     """
-    Convert MATLAB datenum format to Python datetime
+    Converts MATLAB datenum format to Python datetime
 
     Parameters
     ------------

mhkit/utils/type_handling.py

@@ -3,14 +3,6 @@
 to xarray structures such as xarray.DataArray and xarray.Dataset. It also
 includes functions for handling nested dictionaries containing pandas
 DataFrames by converting them to xarray Datasets.
-
-Functions:
-----------
-- to_numeric_array: Converts input data to a numeric NumPy array.
-- convert_to_dataset: Converts pandas or xarray data structures to xarray.Dataset.
-- convert_to_dataarray: Converts various data types to xarray.DataArray.
-- convert_nested_dict_and_pandas: Recursively converts pandas DataFrames
-  in nested dictionaries to xarray Datasets.
 """
 
 from typing import Union, Dict, Any

mhkit/utils/upcrossing.py

@@ -1,28 +1,11 @@
 """
-Upcrossing Analysis Functions
-=============================
 This module contains a collection of functions that facilitate upcrossing
 analyses.
 
-Key Functions:
---------------
-- `upcrossing`: Finds the zero upcrossing points.
-- `peaks`: Finds the peaks between zero crossings.
-- `troughs`: Finds the troughs between zero crossings.
-- `heights`: Calculates the height between zero crossings.
-- `periods`: Calculates the period between zero crossings.
-- `custom`: Applies a custom, user-defined function between zero crossings.
-
-Author:
+Authors:
 -------
 mbruggs
 akeeste
-
-Date:
------
-2023-10-10
-
-
 """
 
 from typing import Callable, Optional