ratios.error_prop_flux_ratios: Minor documentation (iss #5)

astrochun · Mar 7, 2020 · 963cedf · 963cedf
1 parent f949e74
commit 963cedf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/Metallicity_Stack_Commons/ratios.py b/Metallicity_Stack_Commons/ratios.py
@@ -14,16 +14,19 @@ def error_prop_flux_ratios(flux_dict):
     :return flux_ratios_dict: dictionary containing flux ratios
     """
 
+    # Retrieve emission line fluxes
     OII  = flux_dict[line_name_short['OII']]
     OIII = flux_dict[line_name_short['OIII']]
     Hb   = flux_dict[line_name_short['HB']]
     OIII4363 = flux_dict[line_name_short['4363']]
 
+    # Define flux ratios
     two_beta = OII/Hb
     three_beta = OIII/Hb
     logR23 = np.log10(two_beta + three_beta)
     logO32 = np.log10(OIII/OII)
 
+    # Define dictionary of flux ratios
     flux_ratios_dict = dict()
     flux_ratios_dict['two_beta'] = two_beta
     flux_ratios_dict['three_beta'] = three_beta