analysis.composite_indv_detect: Update docstrings for main() (iss #21)

astrochun · Feb 9, 2020 · 3fa2c71 · 3fa2c71
1 parent a38519d
commit 3fa2c71
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/Metallicity_Stack_Commons/analysis/composite_indv_detect.py b/Metallicity_Stack_Commons/analysis/composite_indv_detect.py
@@ -13,10 +13,11 @@ def main(fitspath, dataset, composite_file):
       determine temperature-based metallicity from composite average
       T_e and individual line ratios ([OII]/H-beta, [OIII]/H-beta)
 
-    :param fitspath:
-    :param dataset:
-    :param average_value_ascii:
-    :return:
+    :param fitspath: str containing folder path
+    :param dataset: str containing sub-folder (specific to stacking approach)
+    :param composite_file: str containing filename of composite data
+
+    :return: TBD
     """
 
     # Read in composite table