Add docstring

AlexHls · Nov 9, 2023 · a14ed8a · a14ed8a
1 parent 05a024b
commit a14ed8a
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/tardis/plasma/properties/nlte_population_solver.py b/tardis/plasma/properties/nlte_population_solver.py
@@ -335,6 +335,23 @@ def calculate_delta(
 
 
 def check_negative_population(ion_number_density, electron_densities):
+    """
+    Checks if negative populations are present in the solution and sets them to zero.
+
+    Parameters
+    ----------
+    ion_number_density : pandas.DataFrame
+        Number density with NLTE ionization treatment.
+    electron_densities : Series
+        Electron density with NLTE ionization treatment.
+
+    Returns
+    -------
+    ion_number_density : pandas.DataFrame
+        Number density with NLTE ionization treatment.
+    electron_densities : Series
+        Electron density with NLTE ionization treatment.
+    """
     assert (
         np.greater_equal(
             ion_number_density, NLTE_POPULATION_NEGATIVE_POPULATION_TOLERANCE