Fix docstring issues across the codebase

- Fix D200: Remove periods from one-line docstrings
- Fix D205: Add blank lines between summary and rest of docstring
- Fix D212: Combine multi-line summaries into single lines
- Fix D413: Add blank lines after last paragraph of docstring
- Fix D415: Add periods to end of docstring summaries
- Fix D104: Add module docstrings

All changes are to comply with Pydocstyle conventions.

Author: Uli Köhler

UliEngineering/Chemistry/DaviesEquation.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Davies equation for activity coefficient estimation.
+"""Davies equation for activity coefficient estimation.
 
 The Davies equation is an empirical extension of Debye-Hückel theory
 for estimating activity coefficients at higher ionic strengths (up to ~0.5 M):

UliEngineering/Chemistry/DebyeHuckel.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Debye-Hückel theory for activity coefficients.
+"""Debye-Hückel theory for activity coefficients.
 
 The Debye-Hückel limiting law:
     log10(γ±) = -A * |z+ * z-| * √I
@@ -67,6 +66,7 @@ def debye_huckel_limiting_law(z_plus, z_minus, I: IonicStrengthMolar, A=0.509):
     -------
     float
         log10 of the mean activity coefficient.
+
     """
     I = normalize_ionic_strength(I) if isinstance(I, str) else I
     return -A * np.abs(z_plus * z_minus) * np.sqrt(I)

UliEngineering/Chemistry/Kohlrausch.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Kohlrausch's law of independent migration of ions.
+"""Kohlrausch's law of independent migration of ions.
 
 Kohlrausch's law states that the limiting molar conductivity of an electrolyte
 is the sum of the individual contributions of the cation and anion:

UliEngineering/Chemistry/Pitzer.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Pitzer equations for activity coefficients.
+"""Pitzer equations for activity coefficients.
 
 The Pitzer model is a semi-empirical extension of Debye-Hückel theory
 for concentrated electrolyte solutions (up to ~6 mol/kg).

UliEngineering/Economics/Interest.py

@@ -10,8 +10,7 @@
 ]
 
 def yearly_interest_to_equivalent_monthly_interest(interest):
-    """
-    Given a yearly interest such as 0.022 (= 2.2%), or a numpy ndarray of interests,
+    """Given a yearly interest such as 0.022 (= 2.2%), or a numpy ndarray of interests,
     computes the equivalent monthly interest so that the following holds True:
 
     (1+monthly_interest)**12-1 == yearly_interest.
@@ -26,6 +25,7 @@ def yearly_interest_to_equivalent_monthly_interest(interest):
     float or numpy.ndarray
         Equivalent monthly interest rate.
     """
+
     # 12 months per year
     # monthly interest is 12th root of yearly interest
     # https://techoverflow.net/2022/02/02/numpy-nth-root-how-to/

UliEngineering/Electronics/Hysteresis.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""
-Utilities regarding comparator / opamp hysteresis
+"""Utilities regarding comparator / opamp hysteresis.
 
 For a detailed description please see http://www.ti.com/lit/ug/tidu020a/tidu020a.pdf
 """

UliEngineering/Electronics/Reactance.py

@@ -65,8 +65,7 @@ def inductive_reactance(l: InductanceH, f: FrequencyHz = 1000.0):
 @returns_unit("H")
 def inductance_from_reactance(x: ResistanceOhm, f: FrequencyHz = 1000.0):
     """
-    Compute the inductance (H) from an inductive reactance (Ω) at a given
-    frequency f (Hz).
+    Compute the inductance (H) from an inductive reactance (Ω) at a given frequency f (Hz).
 
     Formula: X_L = 2 * pi * f * L => L = X_L / (2 * pi * f).
 

UliEngineering/Electronics/ZenerDiode.py

@@ -11,9 +11,7 @@
 
 @returns_unit("W")
 def zener_diode_power_dissipation(zener_voltage: VoltageV, current: CurrentA):
-    """
-    Compute the power dissipated in a zener diode
-    given the zener voltage and the current through it.
+    """Compute the power dissipated in a zener diode given the zener voltage and the current through it.
 
     This is based on an ideal zener diode model and does not take into account
     the zener resistance or the zener knee voltage.

UliEngineering/Filesystem/__init__.py

@@ -1 +1,2 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python3
+"""Filesystem utilities."""

UliEngineering/Math/Geometry/Circle.py

@@ -21,8 +21,6 @@ def circle_area(radius: NormalizableArgument):
 
 @returns_unit("m")
 def circle_circumference(radius: NormalizableArgument):
-    """
-    Compute the circumference of a circle from its radius
-    """
+    """Compute the circumference of a circle from its radius."""
     radius = normalize_numeric(radius) if isinstance(radius, str) else radius
     return 2. * math.pi * radius