error_prop.write_npz: Add docstrings (iss #5)

astrochun · Mar 29, 2020 · 3c4dad8 · 3c4dad8
1 parent 2b9be57
commit 3c4dad8
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/Metallicity_Stack_Commons/error_prop.py b/Metallicity_Stack_Commons/error_prop.py
@@ -11,6 +11,16 @@
 
 
 def write_npz(path, npz_files, dict_list):
+    """
+    Purpose:
+      Write numpy files with provided dictionaries
+
+    :param path: str - prefix for filename output
+    :param npz_files: list - contains npz file names
+    :param dict_list: list - contains dictionaries for each corresponding npz file
+
+    :return: Write npz files
+    """
     for file, dict_input in zip(npz_files, dict_list):
         npz_outfile = join(path, file)
         if exists(npz_outfile):