Fix documentation linting errors (D415, D212, D200, D205, D203/D204/D211, D406/D407, D413, D105/D107, D300, D417)

Author: Uli Köhler

UliEngineering/Chemistry/Absorption.py

@@ -339,6 +339,7 @@ class HaleQuerryAbsorptionModel:
     ]
 
     def __init__(self):
+        """Initialize the HaleQuerryAbsorptionModel."""
         # Extract wavelength and extinction coefficient arrays
         self._wavelengths = np.array([d.wavelength for d in self.datapoints])
         self._ext_coeffs = np.array([d.absorption_coefficient for d in self.datapoints])

UliEngineering/Electronics/Filter.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """
-Electronic filter and time constant utilities
+Electronic filter and time constant utilities.
 """
 from typing import Annotated
 

UliEngineering/Electronics/Resistors.py

@@ -1,11 +1,9 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-A python script to calculate E96 resistor values and do other useful things with resistors,
+"""A python script to calculate E96 resistor values and do other useful things with resistors,
 e.g. connect them in parallel and serial fashions.
 
-Originally published at techoverflow.net.
-"""
+Originally published at techoverflow.net."""
 import itertools
 import numpy as np
 from UliEngineering.EngineerIO import normalize_numeric

UliEngineering/Electronics/Thermistor.py

@@ -46,14 +46,21 @@ def thermistor_temperature(resistance: ResistanceOhm, beta: NormalizableArgument
     """
     Calculate the temperature of a NTC thermistor using the Beta parameter model.
 
-    Parameters:
-    - resistance: The measured resistance of the thermistor in Ohms, for which to calculate the temperature.
-    - beta: The Beta constant of the thermistor.
-    - R0: The resistance of the thermistor at reference temperature T0 (default is 10kOhms).
-    - T0: The reference temperature in Celsius (default is 25°C).
+    Parameters
+    ----------
+    resistance : ResistanceOhm
+        The measured resistance of the thermistor in Ohms, for which to calculate the temperature.
+    beta : NormalizableArgument
+        The Beta constant of the thermistor.
+    R0 : ResistanceOhm
+        The resistance of the thermistor at reference temperature T0 (default is 10kOhms).
+    T0 : NormalizableArgument
+        The reference temperature in Celsius (default is 25°C).
 
-    Returns:
-    - Temperature in degrees.
+    Returns
+    -------
+    float
+        Temperature in degrees.
     """
     R0 = normalize_resistance(R0) if isinstance(R0, str) else R0
     T0 = normalize_temperature_kelvin(T0)

UliEngineering/EngineerIO/Area.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Utilities for area
-"""
+"""Utilities for area"""
 from typing import Annotated
 
 from numpy import ndarray
@@ -83,6 +81,7 @@ class EngineerAreaIO(EngineerIO):
     _instance = None
 
     def __init__(self):
+        """Initialize the EngineerAreaIO."""
         # Use area-specific configuration
         super().__init__(config=_create_area_config())
 

UliEngineering/EngineerIO/Concentration.py

@@ -102,6 +102,7 @@ class EngineerAmountConcentrationIO(EngineerIO):
     _instance = None
 
     def __init__(self):
+        """Initialize the EngineerAmountConcentrationIO."""
         super().__init__(config=_create_amount_concentration_config())
 
     @classmethod
@@ -130,7 +131,8 @@ class EngineerMassConcentrationIO(EngineerIO):
     """
     _instance = None
 
-    def __init__(self):
+    def """Initialize the EngineerMassConcentrationIO."""
+        __init__(self):
         super().__init__(config=_create_mass_concentration_config())
 
     @classmethod

UliEngineering/EngineerIO/Decorators.py

@@ -41,8 +41,7 @@ def _normalize_volume_arg(value):
 
 
 def returns_unit(unit):
-    """
-    Decorator to annotate a function with a custom return unit string.
+    """Decorator to annotate a function with a custom return unit string.
 
     Usage: @returns_unit("A").
     """
@@ -123,8 +122,7 @@ def normalize_args(func: None = None, *, exclude=None, instance:Optional[Enginee
 
 
 def normalize_args(func=None, *, exclude=None, instance:Optional[EngineerIO] = None):
-    """
-    Decorator that normalizes arguments before calling the wrapped function.
+    """Decorator that normalizes arguments before calling the wrapped function.
 
     Parameters can declare how they should be normalized using type annotations.
     The most pythonic form is ``typing.Annotated`` metadata:
@@ -139,8 +137,8 @@ def normalize_args(func=None, *, exclude=None, instance:Optional[EngineerIO] = N
     Parameters without metadata still use ``normalize_numeric()`` for backwards
     compatibility with existing functions.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     exclude : list of str, optional
         List of parameter names that should not be normalized
 
@@ -233,8 +231,7 @@ def normalize_numeric_args(func: None = None, *, exclude=None, instance:Optional
 
 
 def normalize_numeric_args(func=None, *, exclude=None, instance:Optional[EngineerIO] = None):
-    """
-    Decorator that applies normalize_numeric to all arguments (args & kwargs)
+    """Decorator that applies normalize_numeric to all arguments (args & kwargs)
     of the decorated function before calling it.
     """
     if exclude is None:

UliEngineering/EngineerIO/Defaults.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Default values and configurations for the EngineerIO library.
-"""
+"""Default values and configurations for the EngineerIO library."""
 from toolz import functoolz
 from typing import Callable, Dict, List, Tuple, Union
 from UliEngineering.EngineerIO.UnitInfo import UnitAlias, UnitInfo

UliEngineering/EngineerIO/Length.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Utilities for length
-"""
+"""Utilities for length."""
 from typing import Annotated
 
 import scipy.constants
@@ -18,7 +16,7 @@
 
 def _length_unit_infos():
     """
-    Returns a list of UnitInfo objects for length units
+    Returns a list of UnitInfo objects for length units.
     """
     return [
         # Base meter unit
@@ -44,7 +42,7 @@ def _length_unit_infos():
 
 def _default_unit_prefix_map_length():
     """
-    Returns the default unit prefix map for length calculations (includes c and d prefixes)
+    Returns the default unit prefix map for length calculations (includes c and d prefixes).
     """
     return {
         'y': -24, 'z': -21, 'a': -18, 'f': -15, 'p': -12,
@@ -56,7 +54,7 @@ def _default_unit_prefix_map_length():
 
 def _create_length_config():
     """
-    Create a custom EngineerIOConfiguration for length units with extended SI prefixes
+    Create a custom EngineerIOConfiguration for length units with extended SI prefixes.
     """
     config = EngineerIOConfiguration.default()
     return EngineerIOConfiguration(
@@ -73,13 +71,14 @@ class EngineerLengthIO(EngineerIO):
     _instance = None
 
     def __init__(self):
+        """Initialize the EngineerLengthIO."""
         # Use length-specific configuration
         super().__init__(config=_create_length_config())
 
     @classmethod
     def instance(cls):
         """
-        Get the singleton instance of EngineerLengthIO
+        Get the singleton instance of EngineerLengthIO.
         """
         if cls._instance is None:
             cls._instance = cls()

UliEngineering/EngineerIO/Timespan.py

@@ -1,8 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Timespan normalization and conversion utilities for UliEngineering
-"""
+"""Timespan normalization and conversion utilities for UliEngineering"""
 from typing import Annotated, cast
 
 from UliEngineering.EngineerIO.Decorators import returns_unit
@@ -64,6 +62,7 @@ class EngineerTimespanIO(EngineerIO):
     _instance = None
 
     def __init__(self):
+        """Initialize the EngineerTimespanIO."""
         # Use timespan-specific configuration
         super().__init__(config=_create_timespan_config())